Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CloudHSMV2.Types.Cluster

Description

Synopsis

data Cluster = Cluster' {
- preCoPassword :: Maybe Text
- stateMessage :: Maybe Text
- state :: Maybe ClusterState
- subnetMapping :: Maybe (HashMap Text Text)
- backupRetentionPolicy :: Maybe BackupRetentionPolicy
- hsms :: Maybe [Hsm]
- vpcId :: Maybe Text
- tagList :: Maybe [Tag]
- sourceBackupId :: Maybe Text
- certificates :: Maybe Certificates
- securityGroup :: Maybe Text
- clusterId :: Maybe Text
- createTimestamp :: Maybe POSIX
- backupPolicy :: Maybe BackupPolicy
- hsmType :: Maybe Text
}
newCluster :: Cluster
cluster_preCoPassword :: Lens' Cluster (Maybe Text)
cluster_stateMessage :: Lens' Cluster (Maybe Text)
cluster_state :: Lens' Cluster (Maybe ClusterState)
cluster_subnetMapping :: Lens' Cluster (Maybe (HashMap Text Text))
cluster_backupRetentionPolicy :: Lens' Cluster (Maybe BackupRetentionPolicy)
cluster_hsms :: Lens' Cluster (Maybe [Hsm])
cluster_vpcId :: Lens' Cluster (Maybe Text)
cluster_tagList :: Lens' Cluster (Maybe [Tag])
cluster_sourceBackupId :: Lens' Cluster (Maybe Text)
cluster_certificates :: Lens' Cluster (Maybe Certificates)
cluster_securityGroup :: Lens' Cluster (Maybe Text)
cluster_clusterId :: Lens' Cluster (Maybe Text)
cluster_createTimestamp :: Lens' Cluster (Maybe UTCTime)
cluster_backupPolicy :: Lens' Cluster (Maybe BackupPolicy)
cluster_hsmType :: Lens' Cluster (Maybe Text)

Documentation

data Cluster Source #

Contains information about an AWS CloudHSM cluster.

See: newCluster smart constructor.

Constructors

Cluster'

Fields

preCoPassword :: Maybe Text
The default password for the cluster's Pre-Crypto Officer (PRECO) user.
stateMessage :: Maybe Text
A description of the cluster's state.
state :: Maybe ClusterState
The cluster's state.
subnetMapping :: Maybe (HashMap Text Text)
A map from availability zone to the cluster’s subnet in that availability zone.
backupRetentionPolicy :: Maybe BackupRetentionPolicy
A policy that defines how the service retains backups.
hsms :: Maybe [Hsm]
Contains information about the HSMs in the cluster.
vpcId :: Maybe Text
The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.
tagList :: Maybe [Tag]
The list of tags for the cluster.
sourceBackupId :: Maybe Text
The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.
certificates :: Maybe Certificates
Contains one or more certificates or a certificate signing request (CSR).
securityGroup :: Maybe Text
The identifier (ID) of the cluster's security group.
clusterId :: Maybe Text
The cluster's identifier (ID).
createTimestamp :: Maybe POSIX
The date and time when the cluster was created.
backupPolicy :: Maybe BackupPolicy
The cluster's backup policy.
hsmType :: Maybe Text
The type of HSM that the cluster contains.

Instances

Instances details

Eq Cluster Source #
Instance details Defined in Amazonka.CloudHSMV2.Types.Cluster Methods (==) :: Cluster -> Cluster -> Bool # (/=) :: Cluster -> Cluster -> Bool #
Read Cluster Source #
Instance details Defined in Amazonka.CloudHSMV2.Types.Cluster Methods readsPrec :: Int -> ReadS Cluster # readList :: ReadS [Cluster] # readPrec :: ReadPrec Cluster # readListPrec :: ReadPrec [Cluster] #
Show Cluster Source #
Instance details Defined in Amazonka.CloudHSMV2.Types.Cluster Methods showsPrec :: Int -> Cluster -> ShowS # show :: Cluster -> String # showList :: [Cluster] -> ShowS #
Generic Cluster Source #
Instance details Defined in Amazonka.CloudHSMV2.Types.Cluster Associated Types type Rep Cluster :: Type -> Type # Methods from :: Cluster -> Rep Cluster x # to :: Rep Cluster x -> Cluster #
NFData Cluster Source #
Instance details Defined in Amazonka.CloudHSMV2.Types.Cluster Methods rnf :: Cluster -> () #
Hashable Cluster Source #
Instance details Defined in Amazonka.CloudHSMV2.Types.Cluster Methods hashWithSalt :: Int -> Cluster -> Int # hash :: Cluster -> Int #
FromJSON Cluster Source #
Instance details Defined in Amazonka.CloudHSMV2.Types.Cluster Methods parseJSON :: Value -> Parser Cluster # parseJSONList :: Value -> Parser [Cluster] #
type Rep Cluster Source #
Instance details Defined in Amazonka.CloudHSMV2.Types.Cluster type Rep Cluster = D1 ('MetaData "Cluster" "Amazonka.CloudHSMV2.Types.Cluster" "libZSservicesZSamazonka-cloudhsmv2ZSamazonka-cloudhsmv2" 'False) (C1 ('MetaCons "Cluster'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "preCoPassword") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "stateMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ClusterState)))) :: ((S1 ('MetaSel ('Just "subnetMapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "backupRetentionPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupRetentionPolicy))) :: (S1 ('MetaSel ('Just "hsms") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Hsm])) :: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: (((S1 ('MetaSel ('Just "tagList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :: S1 ('MetaSel ('Just "sourceBackupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "certificates") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Certificates)) :: S1 ('MetaSel ('Just "securityGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "clusterId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "createTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX))) :: (S1 ('MetaSel ('Just "backupPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BackupPolicy)) :: S1 ('MetaSel ('Just "hsmType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))))

newCluster :: Cluster Source #

Create a value of Cluster 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:preCoPassword:Cluster', cluster_preCoPassword - The default password for the cluster's Pre-Crypto Officer (PRECO) user.

$sel:stateMessage:Cluster', cluster_stateMessage - A description of the cluster's state.

$sel:state:Cluster', cluster_state - The cluster's state.

$sel:subnetMapping:Cluster', cluster_subnetMapping - A map from availability zone to the cluster’s subnet in that availability zone.

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

$sel:hsms:Cluster', cluster_hsms - Contains information about the HSMs in the cluster.

$sel:vpcId:Cluster', cluster_vpcId - The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

$sel:tagList:Cluster', cluster_tagList - The list of tags for the cluster.

$sel:sourceBackupId:Cluster', cluster_sourceBackupId - The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

$sel:certificates:Cluster', cluster_certificates - Contains one or more certificates or a certificate signing request (CSR).

$sel:securityGroup:Cluster', cluster_securityGroup - The identifier (ID) of the cluster's security group.

$sel:clusterId:Cluster', cluster_clusterId - The cluster's identifier (ID).

$sel:createTimestamp:Cluster', cluster_createTimestamp - The date and time when the cluster was created.

$sel:backupPolicy:Cluster', cluster_backupPolicy - The cluster's backup policy.

$sel:hsmType:Cluster', cluster_hsmType - The type of HSM that the cluster contains.

cluster_preCoPassword :: Lens' Cluster (Maybe Text) Source #

The default password for the cluster's Pre-Crypto Officer (PRECO) user.

cluster_stateMessage :: Lens' Cluster (Maybe Text) Source #

A description of the cluster's state.

cluster_state :: Lens' Cluster (Maybe ClusterState) Source #

The cluster's state.

cluster_subnetMapping :: Lens' Cluster (Maybe (HashMap Text Text)) Source #

A map from availability zone to the cluster’s subnet in that availability zone.

cluster_backupRetentionPolicy :: Lens' Cluster (Maybe BackupRetentionPolicy) Source #

A policy that defines how the service retains backups.

cluster_hsms :: Lens' Cluster (Maybe [Hsm]) Source #

Contains information about the HSMs in the cluster.

cluster_vpcId :: Lens' Cluster (Maybe Text) Source #

The identifier (ID) of the virtual private cloud (VPC) that contains the cluster.

cluster_tagList :: Lens' Cluster (Maybe [Tag]) Source #

The list of tags for the cluster.

cluster_sourceBackupId :: Lens' Cluster (Maybe Text) Source #

The identifier (ID) of the backup used to create the cluster. This value exists only when the cluster was created from a backup.

cluster_certificates :: Lens' Cluster (Maybe Certificates) Source #

Contains one or more certificates or a certificate signing request (CSR).

cluster_securityGroup :: Lens' Cluster (Maybe Text) Source #

The identifier (ID) of the cluster's security group.

cluster_clusterId :: Lens' Cluster (Maybe Text) Source #

The cluster's identifier (ID).

cluster_createTimestamp :: Lens' Cluster (Maybe UTCTime) Source #

The date and time when the cluster was created.

cluster_backupPolicy :: Lens' Cluster (Maybe BackupPolicy) Source #

The cluster's backup policy.

cluster_hsmType :: Lens' Cluster (Maybe Text) Source #

The type of HSM that the cluster contains.