package types
import "github.com/aws/aws-sdk-go-v2/service/cloudhsmv2/types"
Index ¶
- type Backup
- type BackupPolicy
- type BackupRetentionPolicy
- type BackupRetentionType
- type BackupState
- type Certificates
- type CloudHsmAccessDeniedException
- func (e *CloudHsmAccessDeniedException) Error() string
- func (e *CloudHsmAccessDeniedException) ErrorCode() string
- func (e *CloudHsmAccessDeniedException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmAccessDeniedException) ErrorMessage() string
- type CloudHsmInternalFailureException
- func (e *CloudHsmInternalFailureException) Error() string
- func (e *CloudHsmInternalFailureException) ErrorCode() string
- func (e *CloudHsmInternalFailureException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmInternalFailureException) ErrorMessage() string
- type CloudHsmInvalidRequestException
- func (e *CloudHsmInvalidRequestException) Error() string
- func (e *CloudHsmInvalidRequestException) ErrorCode() string
- func (e *CloudHsmInvalidRequestException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmInvalidRequestException) ErrorMessage() string
- type CloudHsmResourceLimitExceededException
- func (e *CloudHsmResourceLimitExceededException) Error() string
- func (e *CloudHsmResourceLimitExceededException) ErrorCode() string
- func (e *CloudHsmResourceLimitExceededException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmResourceLimitExceededException) ErrorMessage() string
- type CloudHsmResourceNotFoundException
- func (e *CloudHsmResourceNotFoundException) Error() string
- func (e *CloudHsmResourceNotFoundException) ErrorCode() string
- func (e *CloudHsmResourceNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmResourceNotFoundException) ErrorMessage() string
- type CloudHsmServiceException
- func (e *CloudHsmServiceException) Error() string
- func (e *CloudHsmServiceException) ErrorCode() string
- func (e *CloudHsmServiceException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmServiceException) ErrorMessage() string
- type CloudHsmTagException
- func (e *CloudHsmTagException) Error() string
- func (e *CloudHsmTagException) ErrorCode() string
- func (e *CloudHsmTagException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmTagException) ErrorMessage() string
- type Cluster
- type ClusterMode
- type ClusterState
- type DestinationBackup
- type Hsm
- type HsmState
- type NetworkType
- type Tag
Types ¶
type Backup ¶
type Backup struct { // The identifier (ID) of the backup. // // This member is required. BackupId *string // The Amazon Resource Name (ARN) of the backup. BackupArn *string // The state of the backup. BackupState BackupState // The identifier (ID) of the cluster that was backed up. ClusterId *string // The date and time when the backup was copied from a source backup. CopyTimestamp *time.Time // The date and time when the backup was created. CreateTimestamp *time.Time // The date and time when the backup will be permanently deleted. DeleteTimestamp *time.Time // The HSM type used to create the backup. HsmType *string // The mode of the cluster that was backed up. Mode ClusterMode // Specifies whether the service should exempt a backup from the retention policy // for the cluster. True exempts a backup from the retention policy. False means // the service applies the backup retention policy defined at the cluster. NeverExpires *bool // The identifier (ID) of the source backup from which the new backup was copied. SourceBackup *string // The identifier (ID) of the cluster containing the source backup from which the // new backup was copied. SourceCluster *string // The AWS Region that contains the source backup from which the new backup was // copied. SourceRegion *string // The list of tags for the backup. TagList []Tag // contains filtered or unexported fields }
Contains information about a backup of an CloudHSM cluster. All backup objects contain the BackupId , BackupState , ClusterId , and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp , SourceBackup , SourceCluster , and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.
type BackupPolicy ¶
type BackupPolicy string
const ( BackupPolicyDefault BackupPolicy = "DEFAULT" )
Enum values for BackupPolicy
func (BackupPolicy) Values ¶
func (BackupPolicy) Values() []BackupPolicy
Values returns all known values for BackupPolicy. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type BackupRetentionPolicy ¶
type BackupRetentionPolicy struct { // The type of backup retention policy. For the DAYS type, the value is the number // of days to retain backups. Type BackupRetentionType // Use a value between 7 - 379. Value *string // contains filtered or unexported fields }
A policy that defines the number of days to retain backups.
type BackupRetentionType ¶
type BackupRetentionType string
const ( BackupRetentionTypeDays BackupRetentionType = "DAYS" )
Enum values for BackupRetentionType
func (BackupRetentionType) Values ¶
func (BackupRetentionType) Values() []BackupRetentionType
Values returns all known values for BackupRetentionType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type BackupState ¶
type BackupState string
const ( BackupStateCreateInProgress BackupState = "CREATE_IN_PROGRESS" BackupStateReady BackupState = "READY" BackupStateDeleted BackupState = "DELETED" BackupStatePendingDeletion BackupState = "PENDING_DELETION" )
Enum values for BackupState
func (BackupState) Values ¶
func (BackupState) Values() []BackupState
Values returns all known values for BackupState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Certificates ¶
type Certificates struct { // The HSM hardware certificate issued (signed) by CloudHSM. AwsHardwareCertificate *string // The cluster certificate issued (signed) by the issuing certificate authority // (CA) of the cluster's owner. ClusterCertificate *string // The cluster's certificate signing request (CSR). The CSR exists only when the // cluster's state is UNINITIALIZED . ClusterCsr *string // The HSM certificate issued (signed) by the HSM hardware. HsmCertificate *string // The HSM hardware certificate issued (signed) by the hardware manufacturer. ManufacturerHardwareCertificate *string // contains filtered or unexported fields }
Contains one or more certificates or a certificate signing request (CSR).
type CloudHsmAccessDeniedException ¶
type CloudHsmAccessDeniedException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was rejected because the requester does not have permission to perform the requested operation.
func (*CloudHsmAccessDeniedException) Error ¶
func (e *CloudHsmAccessDeniedException) Error() string
func (*CloudHsmAccessDeniedException) ErrorCode ¶
func (e *CloudHsmAccessDeniedException) ErrorCode() string
func (*CloudHsmAccessDeniedException) ErrorFault ¶
func (e *CloudHsmAccessDeniedException) ErrorFault() smithy.ErrorFault
func (*CloudHsmAccessDeniedException) ErrorMessage ¶
func (e *CloudHsmAccessDeniedException) ErrorMessage() string
type CloudHsmInternalFailureException ¶
type CloudHsmInternalFailureException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was rejected because of an CloudHSM internal failure. The request can be retried.
func (*CloudHsmInternalFailureException) Error ¶
func (e *CloudHsmInternalFailureException) Error() string
func (*CloudHsmInternalFailureException) ErrorCode ¶
func (e *CloudHsmInternalFailureException) ErrorCode() string
func (*CloudHsmInternalFailureException) ErrorFault ¶
func (e *CloudHsmInternalFailureException) ErrorFault() smithy.ErrorFault
func (*CloudHsmInternalFailureException) ErrorMessage ¶
func (e *CloudHsmInternalFailureException) ErrorMessage() string
type CloudHsmInvalidRequestException ¶
type CloudHsmInvalidRequestException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was rejected because it is not a valid request.
func (*CloudHsmInvalidRequestException) Error ¶
func (e *CloudHsmInvalidRequestException) Error() string
func (*CloudHsmInvalidRequestException) ErrorCode ¶
func (e *CloudHsmInvalidRequestException) ErrorCode() string
func (*CloudHsmInvalidRequestException) ErrorFault ¶
func (e *CloudHsmInvalidRequestException) ErrorFault() smithy.ErrorFault
func (*CloudHsmInvalidRequestException) ErrorMessage ¶
func (e *CloudHsmInvalidRequestException) ErrorMessage() string
type CloudHsmResourceLimitExceededException ¶
type CloudHsmResourceLimitExceededException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was rejected because it exceeds an CloudHSM limit.
func (*CloudHsmResourceLimitExceededException) Error ¶
func (e *CloudHsmResourceLimitExceededException) Error() string
func (*CloudHsmResourceLimitExceededException) ErrorCode ¶
func (e *CloudHsmResourceLimitExceededException) ErrorCode() string
func (*CloudHsmResourceLimitExceededException) ErrorFault ¶
func (e *CloudHsmResourceLimitExceededException) ErrorFault() smithy.ErrorFault
func (*CloudHsmResourceLimitExceededException) ErrorMessage ¶
func (e *CloudHsmResourceLimitExceededException) ErrorMessage() string
type CloudHsmResourceNotFoundException ¶
type CloudHsmResourceNotFoundException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was rejected because it refers to a resource that cannot be found.
func (*CloudHsmResourceNotFoundException) Error ¶
func (e *CloudHsmResourceNotFoundException) Error() string
func (*CloudHsmResourceNotFoundException) ErrorCode ¶
func (e *CloudHsmResourceNotFoundException) ErrorCode() string
func (*CloudHsmResourceNotFoundException) ErrorFault ¶
func (e *CloudHsmResourceNotFoundException) ErrorFault() smithy.ErrorFault
func (*CloudHsmResourceNotFoundException) ErrorMessage ¶
func (e *CloudHsmResourceNotFoundException) ErrorMessage() string
type CloudHsmServiceException ¶
type CloudHsmServiceException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was rejected because an error occurred.
func (*CloudHsmServiceException) Error ¶
func (e *CloudHsmServiceException) Error() string
func (*CloudHsmServiceException) ErrorCode ¶
func (e *CloudHsmServiceException) ErrorCode() string
func (*CloudHsmServiceException) ErrorFault ¶
func (e *CloudHsmServiceException) ErrorFault() smithy.ErrorFault
func (*CloudHsmServiceException) ErrorMessage ¶
func (e *CloudHsmServiceException) ErrorMessage() string
type CloudHsmTagException ¶
type CloudHsmTagException struct { Message *string ErrorCodeOverride *string // contains filtered or unexported fields }
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
func (*CloudHsmTagException) Error ¶
func (e *CloudHsmTagException) Error() string
func (*CloudHsmTagException) ErrorCode ¶
func (e *CloudHsmTagException) ErrorCode() string
func (*CloudHsmTagException) ErrorFault ¶
func (e *CloudHsmTagException) ErrorFault() smithy.ErrorFault
func (*CloudHsmTagException) ErrorMessage ¶
func (e *CloudHsmTagException) ErrorMessage() string
type Cluster ¶
type Cluster struct { // The cluster's backup policy. BackupPolicy BackupPolicy // A policy that defines how the service retains backups. BackupRetentionPolicy *BackupRetentionPolicy // Contains one or more certificates or a certificate signing request (CSR). Certificates *Certificates // The cluster's identifier (ID). ClusterId *string // The date and time when the cluster was created. CreateTimestamp *time.Time // The type of HSM that the cluster contains. HsmType *string // The timestamp until when the cluster can be rolled back to its original HSM // type. HsmTypeRollbackExpiration *time.Time // Contains information about the HSMs in the cluster. Hsms []Hsm // The mode of the cluster. Mode ClusterMode // The cluster's NetworkType can be IPv4 (the default) or DUALSTACK. The IPv4 // NetworkType restricts communication between your application and the hardware // security modules (HSMs) to the IPv4 protocol only. The DUALSTACK NetworkType // enables communication over both IPv4 and IPv6 protocols. To use DUALSTACK, // configure your virtual private cloud (VPC) and subnets to support both IPv4 and // IPv6. This configuration involves adding IPv6 Classless Inter-Domain Routing // (CIDR) blocks to the existing IPv4 CIDR blocks in your subnets. The NetworkType // you choose affects the network addressing options for your cluster. DUALSTACK // provides more flexibility by supporting both IPv4 and IPv6 communication. NetworkType NetworkType // The default password for the cluster's Pre-Crypto Officer (PRECO) user. PreCoPassword *string // The identifier (ID) of the cluster's security group. SecurityGroup *string // The identifier (ID) of the backup used to create the cluster. This value exists // only when the cluster was created from a backup. SourceBackupId *string // The cluster's state. State ClusterState // A description of the cluster's state. StateMessage *string // A map from availability zone to the cluster’s subnet in that availability zone. SubnetMapping map[string]string // The list of tags for the cluster. TagList []Tag // The identifier (ID) of the virtual private cloud (VPC) that contains the // cluster. VpcId *string // contains filtered or unexported fields }
Contains information about an CloudHSM cluster.
type ClusterMode ¶
type ClusterMode string
const ( ClusterModeFips ClusterMode = "FIPS" ClusterModeNonFips ClusterMode = "NON_FIPS" )
Enum values for ClusterMode
func (ClusterMode) Values ¶
func (ClusterMode) Values() []ClusterMode
Values returns all known values for ClusterMode. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type ClusterState ¶
type ClusterState string
const ( ClusterStateCreateInProgress ClusterState = "CREATE_IN_PROGRESS" ClusterStateUninitialized ClusterState = "UNINITIALIZED" ClusterStateInitializeInProgress ClusterState = "INITIALIZE_IN_PROGRESS" ClusterStateInitialized ClusterState = "INITIALIZED" ClusterStateActive ClusterState = "ACTIVE" ClusterStateUpdateInProgress ClusterState = "UPDATE_IN_PROGRESS" ClusterStateModifyInProgress ClusterState = "MODIFY_IN_PROGRESS" ClusterStateRollbackInProgress ClusterState = "ROLLBACK_IN_PROGRESS" ClusterStateDeleteInProgress ClusterState = "DELETE_IN_PROGRESS" ClusterStateDeleted ClusterState = "DELETED" ClusterStateDegraded ClusterState = "DEGRADED" )
Enum values for ClusterState
func (ClusterState) Values ¶
func (ClusterState) Values() []ClusterState
Values returns all known values for ClusterState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type DestinationBackup ¶
type DestinationBackup struct { // The date and time when both the source backup was created. CreateTimestamp *time.Time // The identifier (ID) of the source backup from which the new backup was copied. SourceBackup *string // The identifier (ID) of the cluster containing the source backup from which the // new backup was copied. SourceCluster *string // The AWS region that contains the source backup from which the new backup was // copied. SourceRegion *string // contains filtered or unexported fields }
Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.
type Hsm ¶
type Hsm struct { // The HSM's identifier (ID). // // This member is required. HsmId *string // The Availability Zone that contains the HSM. AvailabilityZone *string // The identifier (ID) of the cluster that contains the HSM. ClusterId *string // The identifier (ID) of the HSM's elastic network interface (ENI). EniId *string // The IP address of the HSM's elastic network interface (ENI). EniIp *string // The IPv6 address (if any) of the HSM's elastic network interface (ENI). EniIpV6 *string // The type of HSM. HsmType *string // The HSM's state. State HsmState // A description of the HSM's state. StateMessage *string // The subnet that contains the HSM's elastic network interface (ENI). SubnetId *string // contains filtered or unexported fields }
Contains information about a hardware security module (HSM) in an CloudHSM cluster.
type HsmState ¶
type HsmState string
const ( HsmStateCreateInProgress HsmState = "CREATE_IN_PROGRESS" HsmStateActive HsmState = "ACTIVE" HsmStateDegraded HsmState = "DEGRADED" HsmStateDeleteInProgress HsmState = "DELETE_IN_PROGRESS" HsmStateDeleted HsmState = "DELETED" )
Enum values for HsmState
func (HsmState) Values ¶
Values returns all known values for HsmState. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type NetworkType ¶
type NetworkType string
const ( NetworkTypeIpv4 NetworkType = "IPV4" NetworkTypeDualstack NetworkType = "DUALSTACK" )
Enum values for NetworkType
func (NetworkType) Values ¶
func (NetworkType) Values() []NetworkType
Values returns all known values for NetworkType. Note that this can be expanded in the future, and so it is only as up to date as the client.
The ordering of this slice is not guaranteed to be stable across updates.
type Tag ¶
type Tag struct { // The key of the tag. // // This member is required. Key *string // The value of the tag. // // This member is required. Value *string // contains filtered or unexported fields }
Contains a tag. A tag is a key-value pair.
Source Files ¶
- Version
- v1.30.2 (latest)
- Published
- Apr 3, 2025
- Platform
- js/wasm
- Imports
- 4 packages
- Last checked
- 5 hours ago –
Tools for package owners.