This page documents the language specification for the kubernetes package. If you're looking for help working with the inputs, outputs, or functions of kubernetes resources in a Pulumi program, please see the resource documentation for examples and API reference.
v1beta1¶
- class
pulumi_kubernetes.rbac.v1beta1.ClusterRole(resource_name, opts=None, aggregation_rule=None, metadata=None, rules=None, __name__=None, __opts__=None)¶ ClusterRole is a cluster level, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding or ClusterRoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRole, and will no longer be served in v1.20.
Create a ClusterRole resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
aggregation_rule (pulumi.Input[dict]) – AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
metadata (pulumi.Input[dict]) – Standard object’s metadata.
rules (pulumi.Input[list]) – Rules holds all the PolicyRules for this ClusterRole
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
aggregation_rule: pulumi.Output[dict] = None¶AggregationRule is an optional field that describes how to build the Rules for this ClusterRole. If AggregationRule is set, then the Rules are controller managed and direct changes to Rules will be stomped by the controller.
metadata: pulumi.Output[dict] = None¶Standard object’s metadata.
rules: pulumi.Output[list] = None¶Rules holds all the PolicyRules for this ClusterRole
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
ClusterRoleresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_kubernetes.rbac.v1beta1.ClusterRoleBinding(resource_name, opts=None, role_ref=None, metadata=None, subjects=None, __name__=None, __opts__=None)¶ ClusterRoleBinding references a ClusterRole, but not contain it. It can reference a ClusterRole in the global namespace, and adds who information via Subject. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBinding, and will no longer be served in v1.20.
Create a ClusterRoleBinding resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
role_ref (pulumi.Input[dict]) – RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
metadata (pulumi.Input[dict]) – Standard object’s metadata.
subjects (pulumi.Input[list]) – Subjects holds references to the objects the role applies to.
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata: pulumi.Output[dict] = None¶Standard object’s metadata.
role_ref: pulumi.Output[dict] = None¶RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects: pulumi.Output[list] = None¶Subjects holds references to the objects the role applies to.
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
ClusterRoleBindingresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_kubernetes.rbac.v1beta1.ClusterRoleBindingList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶ ClusterRoleBindingList is a collection of ClusterRoleBindings. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindingList, and will no longer be served in v1.20.
Create a ClusterRoleBindingList resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
items (pulumi.Input[list]) – Items is a list of ClusterRoleBindings
metadata (pulumi.Input[dict]) – Standard object’s metadata.
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
items: pulumi.Output[list] = None¶Items is a list of ClusterRoleBindings
metadata: pulumi.Output[dict] = None¶Standard object’s metadata.
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
ClusterRoleBindingListresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_kubernetes.rbac.v1beta1.ClusterRoleList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶ ClusterRoleList is a collection of ClusterRoles. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoles, and will no longer be served in v1.20.
Create a ClusterRoleList resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
items (pulumi.Input[list]) – Items is a list of ClusterRoles
metadata (pulumi.Input[dict]) – Standard object’s metadata.
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
items: pulumi.Output[list] = None¶Items is a list of ClusterRoles
metadata: pulumi.Output[dict] = None¶Standard object’s metadata.
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
ClusterRoleListresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_kubernetes.rbac.v1beta1.Role(resource_name, opts=None, metadata=None, rules=None, __name__=None, __opts__=None)¶ Role is a namespaced, logical grouping of PolicyRules that can be referenced as a unit by a RoleBinding. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 Role, and will no longer be served in v1.20.
Create a Role resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
metadata (pulumi.Input[dict]) – Standard object’s metadata.
rules (pulumi.Input[list]) – Rules holds all the PolicyRules for this Role
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata: pulumi.Output[dict] = None¶Standard object’s metadata.
rules: pulumi.Output[list] = None¶Rules holds all the PolicyRules for this Role
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
Roleresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_kubernetes.rbac.v1beta1.RoleBinding(resource_name, opts=None, role_ref=None, metadata=None, subjects=None, __name__=None, __opts__=None)¶ RoleBinding references a role, but does not contain it. It can reference a Role in the same namespace or a ClusterRole in the global namespace. It adds who information via Subjects and namespace information by which namespace it exists in. RoleBindings in a given namespace only have effect in that namespace. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBinding, and will no longer be served in v1.20.
Create a RoleBinding resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
role_ref (pulumi.Input[dict]) – RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
metadata (pulumi.Input[dict]) – Standard object’s metadata.
subjects (pulumi.Input[list]) – Subjects holds references to the objects the role applies to.
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
metadata: pulumi.Output[dict] = None¶Standard object’s metadata.
role_ref: pulumi.Output[dict] = None¶RoleRef can reference a Role in the current namespace or a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.
subjects: pulumi.Output[list] = None¶Subjects holds references to the objects the role applies to.
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
RoleBindingresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_kubernetes.rbac.v1beta1.RoleBindingList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶ RoleBindingList is a collection of RoleBindings Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleBindingList, and will no longer be served in v1.20.
Create a RoleBindingList resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
items (pulumi.Input[list]) – Items is a list of RoleBindings
metadata (pulumi.Input[dict]) – Standard object’s metadata.
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
items: pulumi.Output[list] = None¶Items is a list of RoleBindings
metadata: pulumi.Output[dict] = None¶Standard object’s metadata.
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
RoleBindingListresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
- class
pulumi_kubernetes.rbac.v1beta1.RoleList(resource_name, opts=None, items=None, metadata=None, __name__=None, __opts__=None)¶ RoleList is a collection of Roles Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 RoleList, and will no longer be served in v1.20.
Create a RoleList resource with the given unique name, arguments, and options.
- Parameters
resource_name (str) – The unique name of the resource.
opts (pulumi.ResourceOptions) – A bag of options that control this resource’s behavior.
items (pulumi.Input[list]) – Items is a list of Roles
metadata (pulumi.Input[dict]) – Standard object’s metadata.
apiVersion: pulumi.Output[str] = None¶APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#resources
kind: pulumi.Output[str] = None¶Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/api-conventions.md#types-kinds
items: pulumi.Output[list] = None¶Items is a list of Roles
metadata: pulumi.Output[dict] = None¶Standard object’s metadata.
- static
get(resource_name, id, opts=None)¶ Get the state of an existing
RoleListresource, as identified byid. The ID is of the form[namespace]/[name]; if[namespace]is omitted, then (per Kubernetes convention) the ID becomesdefault/[name].Pulumi will keep track of this resource using
resource_nameas the Pulumi ID.- Parameters
resource_name (str) – Unique name used to register this resource with Pulumi.
id (pulumi.Input[str]) – An ID for the Kubernetes resource to retrieve. Takes the form
[namespace]/[name]or[name].opts (Optional[pulumi.ResourceOptions]) – A bag of options that control this resource’s behavior.
translate_output_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str
translate_input_property(prop: str) → str¶Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.
- Parameters
prop (str) – A property name.
- Returns
A potentially transformed property name.
- Return type
str