Module rbac/v1alpha1

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.

Resources

ClusterRole
ClusterRoleBinding
ClusterRoleBindingList
ClusterRoleList
Role
RoleBinding
RoleBindingList
RoleList

Resources

Resource ClusterRole

class ClusterRole extends CustomResource

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.

constructor

new ClusterRole(name: string, args?: ClusterRoleArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterRole resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ClusterRole

Get an existing ClusterRole resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterRole

Returns true if the given object is an instance of ClusterRole. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property aggregationRule

public aggregationRule: pulumi.Output<AggregationRule>;

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.

property apiVersion

public apiVersion: pulumi.Output<"rbac.authorization.k8s.io/v1alpha1">;

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/sig-architecture/api-conventions.md#resources

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<"ClusterRole">;

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/sig-architecture/api-conventions.md#types-kinds

property metadata

public metadata: pulumi.Output<ObjectMeta>;

Standard object’s metadata.

property rules

public rules: pulumi.Output<PolicyRule[]>;

Rules holds all the PolicyRules for this ClusterRole

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterRoleBinding

class ClusterRoleBinding extends CustomResource

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.

constructor

new ClusterRoleBinding(name: string, args?: ClusterRoleBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterRoleBinding resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ClusterRoleBinding

Get an existing ClusterRoleBinding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterRoleBinding

Returns true if the given object is an instance of ClusterRoleBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<"rbac.authorization.k8s.io/v1alpha1">;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<"ClusterRoleBinding">;

property metadata

public metadata: pulumi.Output<ObjectMeta>;

Standard object’s metadata.

property roleRef

public roleRef: pulumi.Output<RoleRef>;

RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.

property subjects

public subjects: pulumi.Output<Subject[]>;

Subjects holds references to the objects the role applies to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterRoleBindingList

class ClusterRoleBindingList extends CustomResource

ClusterRoleBindingList is a collection of ClusterRoleBindings. Deprecated in v1.17 in favor of rbac.authorization.k8s.io/v1 ClusterRoleBindings, and will no longer be served in v1.20.

constructor

new ClusterRoleBindingList(name: string, args?: ClusterRoleBindingListArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterRoleBindingList resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ClusterRoleBindingList

Get an existing ClusterRoleBindingList resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterRoleBindingList

Returns true if the given object is an instance of ClusterRoleBindingList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<"rbac.authorization.k8s.io/v1alpha1">;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property items

public items: pulumi.Output<ClusterRoleBinding[]>;

Items is a list of ClusterRoleBindings

property kind

public kind: pulumi.Output<"ClusterRoleBindingList">;

property metadata

public metadata: pulumi.Output<ListMeta>;

Standard object’s metadata.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource ClusterRoleList

class ClusterRoleList extends CustomResource

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.

constructor

new ClusterRoleList(name: string, args?: ClusterRoleListArgs, opts?: pulumi.CustomResourceOptions)

Create a ClusterRoleList resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): ClusterRoleList

Get an existing ClusterRoleList resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is ClusterRoleList

Returns true if the given object is an instance of ClusterRoleList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<"rbac.authorization.k8s.io/v1alpha1">;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property items

public items: pulumi.Output<ClusterRole[]>;

Items is a list of ClusterRoles

property kind

public kind: pulumi.Output<"ClusterRoleList">;

property metadata

public metadata: pulumi.Output<ListMeta>;

Standard object’s metadata.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Role

class Role extends CustomResource

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.

constructor

new Role(name: string, args?: RoleArgs, opts?: pulumi.CustomResourceOptions)

Create a Role resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Role

Get an existing Role resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Role

Returns true if the given object is an instance of Role. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<"rbac.authorization.k8s.io/v1alpha1">;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<"Role">;

property metadata

public metadata: pulumi.Output<ObjectMeta>;

Standard object’s metadata.

property rules

public rules: pulumi.Output<PolicyRule[]>;

Rules holds all the PolicyRules for this Role

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RoleBinding

class RoleBinding extends CustomResource

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.

constructor

new RoleBinding(name: string, args?: RoleBindingArgs, opts?: pulumi.CustomResourceOptions)

Create a RoleBinding resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): RoleBinding

Get an existing RoleBinding resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RoleBinding

Returns true if the given object is an instance of RoleBinding. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<"rbac.authorization.k8s.io/v1alpha1">;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kind

public kind: pulumi.Output<"RoleBinding">;

property metadata

public metadata: pulumi.Output<ObjectMeta>;

Standard object’s metadata.

property roleRef

public roleRef: pulumi.Output<RoleRef>;

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.

property subjects

public subjects: pulumi.Output<Subject[]>;

Subjects holds references to the objects the role applies to.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RoleBindingList

class RoleBindingList extends CustomResource

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.

constructor

new RoleBindingList(name: string, args?: RoleBindingListArgs, opts?: pulumi.CustomResourceOptions)

Create a RoleBindingList resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): RoleBindingList

Get an existing RoleBindingList resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RoleBindingList

Returns true if the given object is an instance of RoleBindingList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<"rbac.authorization.k8s.io/v1alpha1">;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property items

public items: pulumi.Output<RoleBinding[]>;

Items is a list of RoleBindings

property kind

public kind: pulumi.Output<"RoleBindingList">;

property metadata

public metadata: pulumi.Output<ListMeta>;

Standard object’s metadata.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RoleList

class RoleList extends CustomResource

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.

constructor

new RoleList(name: string, args?: RoleListArgs, opts?: pulumi.CustomResourceOptions)

Create a RoleList resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): RoleList

Get an existing RoleList resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is RoleList

Returns true if the given object is an instance of RoleList. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property apiVersion

public apiVersion: pulumi.Output<"rbac.authorization.k8s.io/v1alpha1">;

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property items

public items: pulumi.Output<Role[]>;

Items is a list of Roles

property kind

public kind: pulumi.Output<"RoleList">;

property metadata

public metadata: pulumi.Output<ListMeta>;

Standard object’s metadata.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface ClusterRoleArgs

interface ClusterRoleArgs

The set of arguments for constructing a ClusterRole resource.

property aggregationRule

aggregationRule?: pulumi.Input<AggregationRule>;

property apiVersion

apiVersion?: pulumi.Input<"rbac.authorization.k8s.io/v1alpha1">;

property kind

kind?: pulumi.Input<"ClusterRole">;

property metadata

metadata?: pulumi.Input<ObjectMeta>;

Standard object’s metadata.

property rules

rules?: pulumi.Input<pulumi.Input<PolicyRule>[]>;

Rules holds all the PolicyRules for this ClusterRole

interface ClusterRoleBindingArgs

interface ClusterRoleBindingArgs

The set of arguments for constructing a ClusterRoleBinding resource.

property apiVersion

apiVersion?: pulumi.Input<"rbac.authorization.k8s.io/v1alpha1">;

property kind

kind?: pulumi.Input<"ClusterRoleBinding">;

property metadata

metadata?: pulumi.Input<ObjectMeta>;

Standard object’s metadata.

property roleRef

roleRef: pulumi.Input<RoleRef>;

RoleRef can only reference a ClusterRole in the global namespace. If the RoleRef cannot be resolved, the Authorizer must return an error.

property subjects

subjects?: pulumi.Input<pulumi.Input<Subject>[]>;

Subjects holds references to the objects the role applies to.

interface ClusterRoleBindingListArgs

interface ClusterRoleBindingListArgs

The set of arguments for constructing a ClusterRoleBindingList resource.

property apiVersion

apiVersion?: pulumi.Input<"rbac.authorization.k8s.io/v1alpha1">;

property items

items: pulumi.Input<pulumi.Input<ClusterRoleBinding>[]>;

Items is a list of ClusterRoleBindings

property kind

kind?: pulumi.Input<"ClusterRoleBindingList">;

property metadata

metadata?: pulumi.Input<ListMeta>;

Standard object’s metadata.

interface ClusterRoleListArgs

interface ClusterRoleListArgs

The set of arguments for constructing a ClusterRoleList resource.

property apiVersion

apiVersion?: pulumi.Input<"rbac.authorization.k8s.io/v1alpha1">;

property items

items: pulumi.Input<pulumi.Input<ClusterRole>[]>;

Items is a list of ClusterRoles

property kind

kind?: pulumi.Input<"ClusterRoleList">;

property metadata

metadata?: pulumi.Input<ListMeta>;

Standard object’s metadata.

interface RoleArgs

interface RoleArgs

The set of arguments for constructing a Role resource.

property apiVersion

apiVersion?: pulumi.Input<"rbac.authorization.k8s.io/v1alpha1">;

property kind

kind?: pulumi.Input<"Role">;

property metadata

metadata?: pulumi.Input<ObjectMeta>;

Standard object’s metadata.

property rules

rules?: pulumi.Input<pulumi.Input<PolicyRule>[]>;

Rules holds all the PolicyRules for this Role

interface RoleBindingArgs

interface RoleBindingArgs

The set of arguments for constructing a RoleBinding resource.

property apiVersion

apiVersion?: pulumi.Input<"rbac.authorization.k8s.io/v1alpha1">;

property kind

kind?: pulumi.Input<"RoleBinding">;

property metadata

metadata?: pulumi.Input<ObjectMeta>;

Standard object’s metadata.

property roleRef

roleRef: pulumi.Input<RoleRef>;

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.

property subjects

subjects?: pulumi.Input<pulumi.Input<Subject>[]>;

Subjects holds references to the objects the role applies to.

interface RoleBindingListArgs

interface RoleBindingListArgs

The set of arguments for constructing a RoleBindingList resource.

property apiVersion

apiVersion?: pulumi.Input<"rbac.authorization.k8s.io/v1alpha1">;

property items

items: pulumi.Input<pulumi.Input<RoleBinding>[]>;

Items is a list of RoleBindings

property kind

kind?: pulumi.Input<"RoleBindingList">;

property metadata

metadata?: pulumi.Input<ListMeta>;

Standard object’s metadata.

interface RoleListArgs

interface RoleListArgs

The set of arguments for constructing a RoleList resource.

property apiVersion

apiVersion?: pulumi.Input<"rbac.authorization.k8s.io/v1alpha1">;

property items

items: pulumi.Input<pulumi.Input<Role>[]>;

Items is a list of Roles

property kind

kind?: pulumi.Input<"RoleList">;

property metadata

metadata?: pulumi.Input<ListMeta>;

Standard object’s metadata.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module rbac/v1alpha1

Resources

Others

Resources

Others