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

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

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

    Using getCluster

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getCluster(args: GetClusterArgs, opts?: InvokeOptions): Promise<GetClusterResult>
function getClusterOutput(args: GetClusterOutputArgs, opts?: InvokeOptions): Output<GetClusterResult>
    def get_cluster(identifier: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(identifier: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetClusterResult]
    func LookupCluster(ctx *Context, args *LookupClusterArgs, opts ...InvokeOption) (*LookupClusterResult, error)
func LookupClusterOutput(ctx *Context, args *LookupClusterOutputArgs, opts ...InvokeOption) LookupClusterResultOutput

    > Note: This function is named LookupCluster in the Go SDK.

    public static class GetCluster 
{
    public static Task<GetClusterResult> InvokeAsync(GetClusterArgs args, InvokeOptions? opts = null)
    public static Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)

    fn::invoke:
  function: aws-native:dsql:getCluster
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Identifier string
    The ID of the created cluster.
    Identifier string
    The ID of the created cluster.
    identifier String
    The ID of the created cluster.
    identifier string
    The ID of the created cluster.
    identifier str
    The ID of the created cluster.
    identifier String
    The ID of the created cluster.

    getCluster Result

    The following output properties are available:

    CreationTime string
    The time of when the cluster was created in ISO-8601 format.
    DeletionProtectionEnabled bool
    Whether deletion protection is enabled in this cluster.
    Identifier string
    The ID of the created cluster.
    MultiRegionProperties Pulumi.AwsNative.Dsql.Outputs.MultiRegionPropertiesProperties
    The Multi-region properties associated to this cluster.
    ResourceArn string
    The Amazon Resource Name (ARN) for the cluster.
    Status string
    The status of the cluster.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    A map of key and value pairs this cluster is tagged with.
    VpcEndpointServiceName string
    The VPC endpoint service name.
    CreationTime string
    The time of when the cluster was created in ISO-8601 format.
    DeletionProtectionEnabled bool
    Whether deletion protection is enabled in this cluster.
    Identifier string
    The ID of the created cluster.
    MultiRegionProperties MultiRegionPropertiesProperties
    The Multi-region properties associated to this cluster.
    ResourceArn string
    The Amazon Resource Name (ARN) for the cluster.
    Status string
    The status of the cluster.
    Tags Tag
    A map of key and value pairs this cluster is tagged with.
    VpcEndpointServiceName string
    The VPC endpoint service name.
    creationTime String
    The time of when the cluster was created in ISO-8601 format.
    deletionProtectionEnabled Boolean
    Whether deletion protection is enabled in this cluster.
    identifier String
    The ID of the created cluster.
    multiRegionProperties MultiRegionPropertiesProperties
    The Multi-region properties associated to this cluster.
    resourceArn String
    The Amazon Resource Name (ARN) for the cluster.
    status String
    The status of the cluster.
    tags List<Tag>
    A map of key and value pairs this cluster is tagged with.
    vpcEndpointServiceName String
    The VPC endpoint service name.
    creationTime string
    The time of when the cluster was created in ISO-8601 format.
    deletionProtectionEnabled boolean
    Whether deletion protection is enabled in this cluster.
    identifier string
    The ID of the created cluster.
    multiRegionProperties MultiRegionPropertiesProperties
    The Multi-region properties associated to this cluster.
    resourceArn string
    The Amazon Resource Name (ARN) for the cluster.
    status string
    The status of the cluster.
    tags Tag[]
    A map of key and value pairs this cluster is tagged with.
    vpcEndpointServiceName string
    The VPC endpoint service name.
    creation_time str
    The time of when the cluster was created in ISO-8601 format.
    deletion_protection_enabled bool
    Whether deletion protection is enabled in this cluster.
    identifier str
    The ID of the created cluster.
    multi_region_properties MultiRegionPropertiesProperties
    The Multi-region properties associated to this cluster.
    resource_arn str
    The Amazon Resource Name (ARN) for the cluster.
    status str
    The status of the cluster.
    tags Sequence[root_Tag]
    A map of key and value pairs this cluster is tagged with.
    vpc_endpoint_service_name str
    The VPC endpoint service name.
    creationTime String
    The time of when the cluster was created in ISO-8601 format.
    deletionProtectionEnabled Boolean
    Whether deletion protection is enabled in this cluster.
    identifier String
    The ID of the created cluster.
    multiRegionProperties Property Map
    The Multi-region properties associated to this cluster.
    resourceArn String
    The Amazon Resource Name (ARN) for the cluster.
    status String
    The status of the cluster.
    tags List<Property Map>
    A map of key and value pairs this cluster is tagged with.
    vpcEndpointServiceName String
    The VPC endpoint service name.

    Supporting Types

    MultiRegionPropertiesProperties

    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

    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