Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. dsql
  5. Cluster

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

aws-native.dsql.Cluster

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::DSQL::Cluster

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args?: ClusterArgs, opts?: CustomResourceOptions);
    @overload
def Cluster(resource_name: str,
            args: Optional[ClusterArgs] = None,
            opts: Optional[ResourceOptions] = None)

@overload
def Cluster(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            deletion_protection_enabled: Optional[bool] = None,
            multi_region_properties: Optional[MultiRegionPropertiesPropertiesArgs] = None,
            tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewCluster(ctx *Context, name string, args *ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs? args = null, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
public Cluster(String name, ClusterArgs args, CustomResourceOptions options)

    type: aws-native:dsql:Cluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    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 ClusterArgs
    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 ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Cluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Cluster resource accepts the following input properties:

    DeletionProtectionEnabled bool
    Whether deletion protection is enabled in this cluster.
    MultiRegionProperties Pulumi.AwsNative.Dsql.Inputs.MultiRegionPropertiesProperties
    The Multi-region properties associated to this cluster.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    A map of key and value pairs this cluster is tagged with.
    DeletionProtectionEnabled bool
    Whether deletion protection is enabled in this cluster.
    MultiRegionProperties MultiRegionPropertiesPropertiesArgs
    The Multi-region properties associated to this cluster.
    Tags TagArgs
    A map of key and value pairs this cluster is tagged with.
    deletionProtectionEnabled Boolean
    Whether deletion protection is enabled in this cluster.
    multiRegionProperties MultiRegionPropertiesProperties
    The Multi-region properties associated to this cluster.
    tags List<Tag>
    A map of key and value pairs this cluster is tagged with.
    deletionProtectionEnabled boolean
    Whether deletion protection is enabled in this cluster.
    multiRegionProperties MultiRegionPropertiesProperties
    The Multi-region properties associated to this cluster.
    tags Tag[]
    A map of key and value pairs this cluster is tagged with.
    deletion_protection_enabled bool
    Whether deletion protection is enabled in this cluster.
    multi_region_properties MultiRegionPropertiesPropertiesArgs
    The Multi-region properties associated to this cluster.
    tags Sequence[TagArgs]
    A map of key and value pairs this cluster is tagged with.
    deletionProtectionEnabled Boolean
    Whether deletion protection is enabled in this cluster.
    multiRegionProperties Property Map
    The Multi-region properties associated to this cluster.
    tags List<Property Map>
    A map of key and value pairs this cluster is tagged with.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    CreationTime string
    The time of when the cluster was created in ISO-8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    The ID of the created cluster.
    ResourceArn string
    The Amazon Resource Name (ARN) for the cluster.
    Status string
    The status of the cluster.
    VpcEndpointServiceName string
    The VPC endpoint service name.
    CreationTime string
    The time of when the cluster was created in ISO-8601 format.
    Id string
    The provider-assigned unique ID for this managed resource.
    Identifier string
    The ID of the created cluster.
    ResourceArn string
    The Amazon Resource Name (ARN) for the cluster.
    Status string
    The status of the cluster.
    VpcEndpointServiceName string
    The VPC endpoint service name.
    creationTime String
    The time of when the cluster was created in ISO-8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    The ID of the created cluster.
    resourceArn String
    The Amazon Resource Name (ARN) for the cluster.
    status String
    The status of the cluster.
    vpcEndpointServiceName String
    The VPC endpoint service name.
    creationTime string
    The time of when the cluster was created in ISO-8601 format.
    id string
    The provider-assigned unique ID for this managed resource.
    identifier string
    The ID of the created cluster.
    resourceArn string
    The Amazon Resource Name (ARN) for the cluster.
    status string
    The status of the cluster.
    vpcEndpointServiceName string
    The VPC endpoint service name.
    creation_time str
    The time of when the cluster was created in ISO-8601 format.
    id str
    The provider-assigned unique ID for this managed resource.
    identifier str
    The ID of the created cluster.
    resource_arn str
    The Amazon Resource Name (ARN) for the cluster.
    status str
    The status of the cluster.
    vpc_endpoint_service_name str
    The VPC endpoint service name.
    creationTime String
    The time of when the cluster was created in ISO-8601 format.
    id String
    The provider-assigned unique ID for this managed resource.
    identifier String
    The ID of the created cluster.
    resourceArn String
    The Amazon Resource Name (ARN) for the cluster.
    status String
    The status of the cluster.
    vpcEndpointServiceName String
    The VPC endpoint service name.

    Supporting Types

    MultiRegionPropertiesProperties, MultiRegionPropertiesPropertiesArgs

    Clusters List<string>
    The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.
    WitnessRegion string
    The witness region in a multi-region cluster.
    Clusters []string
    The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.
    WitnessRegion string
    The witness region in a multi-region cluster.
    clusters List<String>
    The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.
    witnessRegion String
    The witness region in a multi-region cluster.
    clusters string[]
    The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.
    witnessRegion string
    The witness region in a multi-region cluster.
    clusters Sequence[str]
    The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.
    witness_region str
    The witness region in a multi-region cluster.
    clusters List<String>
    The set of peered clusters that form the multi-Region cluster configuration. Each peered cluster represents a database instance in a different Region.
    witnessRegion String
    The witness region in a multi-region cluster.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.30.0 published on Monday, Jun 16, 2025 by Pulumi
    pulumi/pulumi-aws-native