Class: Aws::CloudHSMV2::Types::CreateClusterRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb

Overview

Note:

When making an API call, you may pass CreateClusterRequest data as a hash:

{
  backup_retention_policy: {
    type: "DAYS", # accepts DAYS
    value: "BackupRetentionValue",
  },
  hsm_type: "HsmType", # required
  source_backup_id: "BackupId",
  subnet_ids: ["SubnetId"], # required
  tag_list: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#backup_retention_policy ⇒ Types::BackupRetentionPolicy

A policy that defines how the service retains backups.

Returns:



435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 435

class CreateClusterRequest < Struct.new(
  :backup_retention_policy,
  :hsm_type,
  :source_backup_id,
  :subnet_ids,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#hsm_type ⇒ String

The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.

Returns:

  • (String) 


435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 435

class CreateClusterRequest < Struct.new(
  :backup_retention_policy,
  :hsm_type,
  :source_backup_id,
  :subnet_ids,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#source_backup_id ⇒ String

The identifier (ID) of the cluster backup to restore. Use this value to restore the cluster from a backup instead of creating a new cluster. To find the backup ID, use DescribeBackups.

Returns:

  • (String) 


435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 435

class CreateClusterRequest < Struct.new(
  :backup_retention_policy,
  :hsm_type,
  :source_backup_id,
  :subnet_ids,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#subnet_ids ⇒ Array<String>

The identifiers (IDs) of the subnets where you are creating the cluster. You must specify at least one subnet. If you specify multiple subnets, they must meet the following criteria:

  • All subnets must be in the same virtual private cloud (VPC).

  • You can specify only one subnet per Availability Zone.

Returns:

  • (Array<String>) 


435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 435

class CreateClusterRequest < Struct.new(
  :backup_retention_policy,
  :hsm_type,
  :source_backup_id,
  :subnet_ids,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end

#tag_list ⇒ Array<Types::Tag>

Tags to apply to the CloudHSM cluster during creation.

Returns:



435
436
437
438
439
440
441
442
443
 
# File 'gems/aws-sdk-cloudhsmv2/lib/aws-sdk-cloudhsmv2/types.rb', line 435

class CreateClusterRequest < Struct.new(
  :backup_retention_policy,
  :hsm_type,
  :source_backup_id,
  :subnet_ids,
  :tag_list)
  SENSITIVE = []
  include Aws::Structure
end