cockroach.Cmek
Explore with Pulumi AI
Customer-managed encryption keys (CMEK) resource for a single cluster
Create Cmek Resource
new Cmek(name: string, args: CmekArgs, opts?: CustomResourceOptions);
@overload
def Cmek(resource_name: str,
opts: Optional[ResourceOptions] = None,
additional_regions: Optional[Sequence[CmekAdditionalRegionArgs]] = None,
cluster_id: Optional[str] = None,
regions: Optional[Sequence[CmekRegionArgs]] = None,
status: Optional[str] = None)
@overload
def Cmek(resource_name: str,
args: CmekArgs,
opts: Optional[ResourceOptions] = None)
func NewCmek(ctx *Context, name string, args CmekArgs, opts ...ResourceOption) (*Cmek, error)
public Cmek(string name, CmekArgs args, CustomResourceOptions? opts = null)
type: cockroach:Cmek
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CmekArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args CmekArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args CmekArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args CmekArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args CmekArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Cmek Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The Cmek resource accepts the following input properties:
- Cluster
Id string Cluster ID
- Regions
List<Lbrlabs.
Pulumi Package. Cockroach. Inputs. Cmek Region> - Additional
Regions List<Lbrlabs.Pulumi Package. Cockroach. Inputs. Cmek Additional Region> Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- Status string
Aggregated status of the cluster's encryption key(s)
- Cluster
Id string Cluster ID
- Regions
[]Cmek
Region Args - Additional
Regions []CmekAdditional Region Args Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- Status string
Aggregated status of the cluster's encryption key(s)
- cluster
Id String Cluster ID
- regions
List<Cmek
Region> - additional
Regions List<CmekAdditional Region> Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- status String
Aggregated status of the cluster's encryption key(s)
- cluster
Id string Cluster ID
- regions
Cmek
Region[] - additional
Regions CmekAdditional Region[] Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- status string
Aggregated status of the cluster's encryption key(s)
- cluster_
id str Cluster ID
- regions
Sequence[Cmek
Region Args] - additional_
regions Sequence[CmekAdditional Region Args] Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- status str
Aggregated status of the cluster's encryption key(s)
- cluster
Id String Cluster ID
- regions List<Property Map>
- additional
Regions List<Property Map> Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- status String
Aggregated status of the cluster's encryption key(s)
Outputs
All input properties are implicitly available as output properties. Additionally, the Cmek resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up Existing Cmek Resource
Get an existing Cmek resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: CmekState, opts?: CustomResourceOptions): Cmek
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
additional_regions: Optional[Sequence[CmekAdditionalRegionArgs]] = None,
cluster_id: Optional[str] = None,
regions: Optional[Sequence[CmekRegionArgs]] = None,
status: Optional[str] = None) -> Cmek
func GetCmek(ctx *Context, name string, id IDInput, state *CmekState, opts ...ResourceOption) (*Cmek, error)
public static Cmek Get(string name, Input<string> id, CmekState? state, CustomResourceOptions? opts = null)
public static Cmek get(String name, Output<String> id, CmekState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Additional
Regions List<Lbrlabs.Pulumi Package. Cockroach. Inputs. Cmek Additional Region> Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- Cluster
Id string Cluster ID
- Regions
List<Lbrlabs.
Pulumi Package. Cockroach. Inputs. Cmek Region> - Status string
Aggregated status of the cluster's encryption key(s)
- Additional
Regions []CmekAdditional Region Args Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- Cluster
Id string Cluster ID
- Regions
[]Cmek
Region Args - Status string
Aggregated status of the cluster's encryption key(s)
- additional
Regions List<CmekAdditional Region> Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- cluster
Id String Cluster ID
- regions
List<Cmek
Region> - status String
Aggregated status of the cluster's encryption key(s)
- additional
Regions CmekAdditional Region[] Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- cluster
Id string Cluster ID
- regions
Cmek
Region[] - status string
Aggregated status of the cluster's encryption key(s)
- additional_
regions Sequence[CmekAdditional Region Args] Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- cluster_
id str Cluster ID
- regions
Sequence[Cmek
Region Args] - status str
Aggregated status of the cluster's encryption key(s)
- additional
Regions List<Property Map> Once CMEK is enabled for a cluster, no new regions can be added to the cluster resource, since they need encryption key info stored in the CMEK resource. New regions can be added and maintained here instead.
- cluster
Id String Cluster ID
- regions List<Property Map>
- status String
Aggregated status of the cluster's encryption key(s)
Supporting Types
CmekAdditionalRegion, CmekAdditionalRegionArgs
- name str
- node_
count int - primary bool
Set to true to mark this region as the primary for a Serverless cluster. Exactly one region must be primary. Dedicated clusters expect to have no primary region.
- sql_
dns str - ui_
dns str
CmekRegion, CmekRegionArgs
- Key
Lbrlabs.
Pulumi Package. Cockroach. Inputs. Cmek Region Key - Region string
- Status string
Aggregated status of the cluster's encryption key(s)
- Key
Cmek
Region Key - Region string
- Status string
Aggregated status of the cluster's encryption key(s)
- key
Cmek
Region Key - region String
- status String
Aggregated status of the cluster's encryption key(s)
- key
Cmek
Region Key - region string
- status string
Aggregated status of the cluster's encryption key(s)
- key
Cmek
Region Key - region str
- status str
Aggregated status of the cluster's encryption key(s)
- key Property Map
- region String
- status String
Aggregated status of the cluster's encryption key(s)
CmekRegionKey, CmekRegionKeyArgs
- Auth
Principal string - Type string
- Uri string
- Created
At string - Status string
Aggregated status of the cluster's encryption key(s)
- Updated
At string - User
Message string
- Auth
Principal string - Type string
- Uri string
- Created
At string - Status string
Aggregated status of the cluster's encryption key(s)
- Updated
At string - User
Message string
- auth
Principal String - type String
- uri String
- created
At String - status String
Aggregated status of the cluster's encryption key(s)
- updated
At String - user
Message String
- auth
Principal string - type string
- uri string
- created
At string - status string
Aggregated status of the cluster's encryption key(s)
- updated
At string - user
Message string
- auth_
principal str - type str
- uri str
- created_
at str - status str
Aggregated status of the cluster's encryption key(s)
- updated_
at str - user_
message str
- auth
Principal String - type String
- uri String
- created
At String - status String
Aggregated status of the cluster's encryption key(s)
- updated
At String - user
Message String
Package Details
- Repository
- cockroach lbrlabs/pulumi-cockroach
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
cockroach
Terraform Provider.