libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CloudHSMV2.CreateCluster

Description

Creates a new AWS CloudHSM cluster.

Synopsis

Creating a Request

data CreateCluster Source #

See: newCreateCluster smart constructor.

Constructors

CreateCluster' 

Fields

  • backupRetentionPolicy :: Maybe BackupRetentionPolicy

    A policy that defines how the service retains backups.

  • tagList :: Maybe [Tag]

    Tags to apply to the CloudHSM cluster during creation.

  • sourceBackupId :: Maybe Text

    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.

  • hsmType :: Text

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

  • subnetIds :: NonEmpty Text

    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.

Instances

Instances details
Eq CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Read CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Show CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Generic CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Associated Types

type Rep CreateCluster :: Type -> Type #

NFData CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Methods

rnf :: CreateCluster -> () #

Hashable CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

ToJSON CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

AWSRequest CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Associated Types

type AWSResponse CreateCluster #

ToHeaders CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

ToPath CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

ToQuery CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

type Rep CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

type Rep CreateCluster = D1 ('MetaData "CreateCluster" "Amazonka.CloudHSMV2.CreateCluster" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "CreateCluster'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "backupRetentionPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupRetentionPolicy)) :*: S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :*: (S1 ('MetaSel ('Just "sourceBackupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "hsmType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text))))))
type AWSResponse CreateCluster Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

newCreateCluster Source #

Create a value of CreateCluster with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:backupRetentionPolicy:CreateCluster', createCluster_backupRetentionPolicy - A policy that defines how the service retains backups.

$sel:tagList:CreateCluster', createCluster_tagList - Tags to apply to the CloudHSM cluster during creation.

$sel:sourceBackupId:CreateCluster', createCluster_sourceBackupId - 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.

$sel:hsmType:CreateCluster', createCluster_hsmType - The type of HSM to use in the cluster. Currently the only allowed value is hsm1.medium.

$sel:subnetIds:CreateCluster', createCluster_subnetIds - 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.

Request Lenses

createCluster_backupRetentionPolicy :: Lens' CreateCluster (Maybe BackupRetentionPolicy) Source #

A policy that defines how the service retains backups.

createCluster_tagList :: Lens' CreateCluster (Maybe [Tag]) Source #

Tags to apply to the CloudHSM cluster during creation.

createCluster_sourceBackupId :: Lens' CreateCluster (Maybe Text) Source #

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.

createCluster_hsmType :: Lens' CreateCluster Text Source #

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

createCluster_subnetIds :: Lens' CreateCluster (NonEmpty Text) Source #

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.

Destructuring the Response

data CreateClusterResponse Source #

See: newCreateClusterResponse smart constructor.

Constructors

CreateClusterResponse' 

Fields

Instances

Instances details
Eq CreateClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Read CreateClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Show CreateClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Generic CreateClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Associated Types

type Rep CreateClusterResponse :: Type -> Type #

NFData CreateClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

Methods

rnf :: CreateClusterResponse -> () #

type Rep CreateClusterResponse Source # 
Instance details

Defined in Amazonka.CloudHSMV2.CreateCluster

type Rep CreateClusterResponse = D1 ('MetaData "CreateClusterResponse" "Amazonka.CloudHSMV2.CreateCluster" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "CreateClusterResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "cluster") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Cluster)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateClusterResponse Source #

Create a value of CreateClusterResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:cluster:CreateClusterResponse', createClusterResponse_cluster - Information about the cluster that was created.

$sel:httpStatus:CreateClusterResponse', createClusterResponse_httpStatus - The response's http status code.

Response Lenses

createClusterResponse_cluster :: Lens' CreateClusterResponse (Maybe Cluster) Source #

Information about the cluster that was created.