1. Packages
  2. CockroachDB Cloud
  3. API Docs
  4. Cmek
CockroachDB v0.0.3 published on Wednesday, Jul 12, 2023 by lbrlabs

cockroach.Cmek

Explore with Pulumi AI

cockroach logo
CockroachDB v0.0.3 published on Wednesday, Jul 12, 2023 by lbrlabs

    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)
    public Cmek(String name, CmekArgs args)
    public Cmek(String name, CmekArgs args, CustomResourceOptions options)
    
    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:

    ClusterId string

    Cluster ID

    Regions List<Lbrlabs.PulumiPackage.Cockroach.Inputs.CmekRegion>
    AdditionalRegions List<Lbrlabs.PulumiPackage.Cockroach.Inputs.CmekAdditionalRegion>

    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)

    ClusterId string

    Cluster ID

    Regions []CmekRegionArgs
    AdditionalRegions []CmekAdditionalRegionArgs

    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)

    clusterId String

    Cluster ID

    regions List<CmekRegion>
    additionalRegions List<CmekAdditionalRegion>

    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)

    clusterId string

    Cluster ID

    regions CmekRegion[]
    additionalRegions CmekAdditionalRegion[]

    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[CmekRegionArgs]
    additional_regions Sequence[CmekAdditionalRegionArgs]

    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)

    clusterId String

    Cluster ID

    regions List<Property Map>
    additionalRegions 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.
    The following state arguments are supported:
    AdditionalRegions List<Lbrlabs.PulumiPackage.Cockroach.Inputs.CmekAdditionalRegion>

    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.

    ClusterId string

    Cluster ID

    Regions List<Lbrlabs.PulumiPackage.Cockroach.Inputs.CmekRegion>
    Status string

    Aggregated status of the cluster's encryption key(s)

    AdditionalRegions []CmekAdditionalRegionArgs

    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.

    ClusterId string

    Cluster ID

    Regions []CmekRegionArgs
    Status string

    Aggregated status of the cluster's encryption key(s)

    additionalRegions List<CmekAdditionalRegion>

    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.

    clusterId String

    Cluster ID

    regions List<CmekRegion>
    status String

    Aggregated status of the cluster's encryption key(s)

    additionalRegions CmekAdditionalRegion[]

    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.

    clusterId string

    Cluster ID

    regions CmekRegion[]
    status string

    Aggregated status of the cluster's encryption key(s)

    additional_regions Sequence[CmekAdditionalRegionArgs]

    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[CmekRegionArgs]
    status str

    Aggregated status of the cluster's encryption key(s)

    additionalRegions 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.

    clusterId String

    Cluster ID

    regions List<Property Map>
    status String

    Aggregated status of the cluster's encryption key(s)

    Supporting Types

    CmekAdditionalRegion, CmekAdditionalRegionArgs

    Name string
    NodeCount 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.

    SqlDns string
    UiDns string
    Name string
    NodeCount 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.

    SqlDns string
    UiDns string
    name String
    nodeCount Integer
    primary Boolean

    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.

    sqlDns String
    uiDns String
    name string
    nodeCount number
    primary boolean

    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.

    sqlDns string
    uiDns string
    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
    name String
    nodeCount Number
    primary Boolean

    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.

    sqlDns String
    uiDns String

    CmekRegion, CmekRegionArgs

    Key Lbrlabs.PulumiPackage.Cockroach.Inputs.CmekRegionKey
    Region string
    Status string

    Aggregated status of the cluster's encryption key(s)

    Key CmekRegionKey
    Region string
    Status string

    Aggregated status of the cluster's encryption key(s)

    key CmekRegionKey
    region String
    status String

    Aggregated status of the cluster's encryption key(s)

    key CmekRegionKey
    region string
    status string

    Aggregated status of the cluster's encryption key(s)

    key CmekRegionKey
    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

    AuthPrincipal string
    Type string
    Uri string
    CreatedAt string
    Status string

    Aggregated status of the cluster's encryption key(s)

    UpdatedAt string
    UserMessage string
    AuthPrincipal string
    Type string
    Uri string
    CreatedAt string
    Status string

    Aggregated status of the cluster's encryption key(s)

    UpdatedAt string
    UserMessage string
    authPrincipal String
    type String
    uri String
    createdAt String
    status String

    Aggregated status of the cluster's encryption key(s)

    updatedAt String
    userMessage String
    authPrincipal string
    type string
    uri string
    createdAt string
    status string

    Aggregated status of the cluster's encryption key(s)

    updatedAt string
    userMessage 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
    authPrincipal String
    type String
    uri String
    createdAt String
    status String

    Aggregated status of the cluster's encryption key(s)

    updatedAt String
    userMessage String

    Package Details

    Repository
    cockroach lbrlabs/pulumi-cockroach
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the cockroach Terraform Provider.

    cockroach logo
    CockroachDB v0.0.3 published on Wednesday, Jul 12, 2023 by lbrlabs