Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. AWS Cloud Control
  4. API Docs
  5. cloudhsm
  6. getCluster

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

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

aws-native.cloudhsm.getCluster

aws-native logo aws-native logo

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

Viewing docs for AWS Cloud Control v1.79.0
published on Monday, Sep 14, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-aws-native

    Creates and manages an AWS CloudHSM 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?: InvokeOutputOptions): Output<GetClusterResult>
    def get_cluster(arn: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetClusterResult
def get_cluster_output(arn: pulumi.Input[Optional[str]] = None,
                opts: Optional[InvokeOutputOptions] = 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 Output<GetClusterResult> Invoke(GetClusterInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOptions options)
public static Output<GetClusterResult> getCluster(GetClusterArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: aws-native:cloudhsm:getCluster
  arguments:
    # arguments dictionary
    data "aws-native_cloudhsm_get_cluster" "name" {
    # arguments
}

    The following arguments are supported:

    Arn string
    The Amazon Resource Name (ARN) of the cluster.
    Arn string
    The Amazon Resource Name (ARN) of the cluster.
    arn string
    The Amazon Resource Name (ARN) of the cluster.
    arn String
    The Amazon Resource Name (ARN) of the cluster.
    arn string
    The Amazon Resource Name (ARN) of the cluster.
    arn str
    The Amazon Resource Name (ARN) of the cluster.
    arn String
    The Amazon Resource Name (ARN) of the cluster.

    getCluster Result

    The following output properties are available:

    Arn string
    The Amazon Resource Name (ARN) of the cluster.
    BackupPolicy Pulumi.AwsNative.CloudHsm.ClusterBackupPolicy
    The cluster's backup policy.
    BackupRetentionPolicy Pulumi.AwsNative.CloudHsm.Outputs.BackupRetentionPolicyProperties
    A policy that defines how the service retains backups.
    ClusterId string
    The cluster's identifier (ID).
    SecurityGroup string
    The identifier (ID) of the cluster's security group.
    State Pulumi.AwsNative.CloudHsm.ClusterState
    The cluster's state.
    SubnetMapping Dictionary<string, string>
    A map from availability zone to the cluster's subnet in that availability zone.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    Tags to apply to the CloudHSM cluster.
    VpcId string
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    Arn string
    The Amazon Resource Name (ARN) of the cluster.
    BackupPolicy ClusterBackupPolicy
    The cluster's backup policy.
    BackupRetentionPolicy BackupRetentionPolicyProperties
    A policy that defines how the service retains backups.
    ClusterId string
    The cluster's identifier (ID).
    SecurityGroup string
    The identifier (ID) of the cluster's security group.
    State ClusterStateEnum
    The cluster's state.
    SubnetMapping map[string]string
    A map from availability zone to the cluster's subnet in that availability zone.
    Tags Tag
    Tags to apply to the CloudHSM cluster.
    VpcId string
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn string
    The Amazon Resource Name (ARN) of the cluster.
    backup_policy "DEFAULT"
    The cluster's backup policy.
    backup_retention_policy object
    A policy that defines how the service retains backups.
    cluster_id string
    The cluster's identifier (ID).
    security_group string
    The identifier (ID) of the cluster's security group.
    state "CREATE_IN_PROGRESS" | "UNINITIALIZED" | "INITIALIZE_IN_PROGRESS" | "INITIALIZED" | "ACTIVE" | "UPDATE_IN_PROGRESS" | "MODIFY_IN_PROGRESS" | "ROLLBACK_IN_PROGRESS" | "DELETE_IN_PROGRESS" | "DELETED" | "DEGRADED"
    The cluster's state.
    subnet_mapping map(string)
    A map from availability zone to the cluster's subnet in that availability zone.
    tags list(object)
    Tags to apply to the CloudHSM cluster.
    vpc_id string
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn String
    The Amazon Resource Name (ARN) of the cluster.
    backupPolicy ClusterBackupPolicy
    The cluster's backup policy.
    backupRetentionPolicy BackupRetentionPolicyProperties
    A policy that defines how the service retains backups.
    clusterId String
    The cluster's identifier (ID).
    securityGroup String
    The identifier (ID) of the cluster's security group.
    state ClusterState
    The cluster's state.
    subnetMapping Map<String,String>
    A map from availability zone to the cluster's subnet in that availability zone.
    tags List<Tag>
    Tags to apply to the CloudHSM cluster.
    vpcId String
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn string
    The Amazon Resource Name (ARN) of the cluster.
    backupPolicy ClusterBackupPolicy
    The cluster's backup policy.
    backupRetentionPolicy BackupRetentionPolicyProperties
    A policy that defines how the service retains backups.
    clusterId string
    The cluster's identifier (ID).
    securityGroup string
    The identifier (ID) of the cluster's security group.
    state ClusterState
    The cluster's state.
    subnetMapping {[key: string]: string}
    A map from availability zone to the cluster's subnet in that availability zone.
    tags Tag[]
    Tags to apply to the CloudHSM cluster.
    vpcId string
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn str
    The Amazon Resource Name (ARN) of the cluster.
    backup_policy ClusterBackupPolicy
    The cluster's backup policy.
    backup_retention_policy BackupRetentionPolicyProperties
    A policy that defines how the service retains backups.
    cluster_id str
    The cluster's identifier (ID).
    security_group str
    The identifier (ID) of the cluster's security group.
    state ClusterState
    The cluster's state.
    subnet_mapping Mapping[str, str]
    A map from availability zone to the cluster's subnet in that availability zone.
    tags Sequence[root_Tag]
    Tags to apply to the CloudHSM cluster.
    vpc_id str
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
    arn String
    The Amazon Resource Name (ARN) of the cluster.
    backupPolicy "DEFAULT"
    The cluster's backup policy.
    backupRetentionPolicy Property Map
    A policy that defines how the service retains backups.
    clusterId String
    The cluster's identifier (ID).
    securityGroup String
    The identifier (ID) of the cluster's security group.
    state "CREATE_IN_PROGRESS" | "UNINITIALIZED" | "INITIALIZE_IN_PROGRESS" | "INITIALIZED" | "ACTIVE" | "UPDATE_IN_PROGRESS" | "MODIFY_IN_PROGRESS" | "ROLLBACK_IN_PROGRESS" | "DELETE_IN_PROGRESS" | "DELETED" | "DEGRADED"
    The cluster's state.
    subnetMapping Map<String>
    A map from availability zone to the cluster's subnet in that availability zone.
    tags List<Property Map>
    Tags to apply to the CloudHSM cluster.
    vpcId String
    The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

    Supporting Types

    BackupRetentionPolicyProperties

    Type Pulumi.AwsNative.CloudHsm.ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    Value string
    Use a value between 7 - 379.
    Type ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    Value string
    Use a value between 7 - 379.
    type "DAYS"
    The type of backup retention policy.
    value string
    Use a value between 7 - 379.
    type ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    value String
    Use a value between 7 - 379.
    type ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    value string
    Use a value between 7 - 379.
    type ClusterBackupRetentionPolicyPropertiesType
    The type of backup retention policy.
    value str
    Use a value between 7 - 379.
    type "DAYS"
    The type of backup retention policy.
    value String
    Use a value between 7 - 379.

    ClusterBackupPolicy

    ClusterBackupRetentionPolicyPropertiesType

    ClusterState

    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 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 aws-native logo

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

    Viewing docs for AWS Cloud Control v1.79.0
    published on Monday, Sep 14, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-aws-native

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial