Documentation
¶
Index ¶
- type Backup
- type BackupPolicy
- 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
- func (e *CloudHsmAccessDeniedException) GetMessage() string
- func (e *CloudHsmAccessDeniedException) HasMessage() bool
- type CloudHsmInternalFailureException
- func (e *CloudHsmInternalFailureException) Error() string
- func (e *CloudHsmInternalFailureException) ErrorCode() string
- func (e *CloudHsmInternalFailureException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmInternalFailureException) ErrorMessage() string
- func (e *CloudHsmInternalFailureException) GetMessage() string
- func (e *CloudHsmInternalFailureException) HasMessage() bool
- type CloudHsmInvalidRequestException
- func (e *CloudHsmInvalidRequestException) Error() string
- func (e *CloudHsmInvalidRequestException) ErrorCode() string
- func (e *CloudHsmInvalidRequestException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmInvalidRequestException) ErrorMessage() string
- func (e *CloudHsmInvalidRequestException) GetMessage() string
- func (e *CloudHsmInvalidRequestException) HasMessage() bool
- type CloudHsmResourceNotFoundException
- func (e *CloudHsmResourceNotFoundException) Error() string
- func (e *CloudHsmResourceNotFoundException) ErrorCode() string
- func (e *CloudHsmResourceNotFoundException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmResourceNotFoundException) ErrorMessage() string
- func (e *CloudHsmResourceNotFoundException) GetMessage() string
- func (e *CloudHsmResourceNotFoundException) HasMessage() bool
- type CloudHsmServiceException
- func (e *CloudHsmServiceException) Error() string
- func (e *CloudHsmServiceException) ErrorCode() string
- func (e *CloudHsmServiceException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmServiceException) ErrorMessage() string
- func (e *CloudHsmServiceException) GetMessage() string
- func (e *CloudHsmServiceException) HasMessage() bool
- type CloudHsmTagException
- func (e *CloudHsmTagException) Error() string
- func (e *CloudHsmTagException) ErrorCode() string
- func (e *CloudHsmTagException) ErrorFault() smithy.ErrorFault
- func (e *CloudHsmTagException) ErrorMessage() string
- func (e *CloudHsmTagException) GetMessage() string
- func (e *CloudHsmTagException) HasMessage() bool
- type Cluster
- type ClusterState
- type DestinationBackup
- type Hsm
- type HsmState
- type Tag
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Backup ¶
type Backup struct {
// The AWS Region that contains the source backup from which the new backup was
// copied.
SourceRegion *string
// The identifier (ID) of the backup.
BackupId *string
// The date and time when the backup was copied from a source backup.
CopyTimestamp *time.Time
// The date and time when the backup will be permanently deleted.
DeleteTimestamp *time.Time
// The identifier (ID) of the cluster that was backed up.
ClusterId *string
// The identifier (ID) of the source backup from which the new backup was copied.
SourceBackup *string
// The date and time when the backup was created.
CreateTimestamp *time.Time
// The list of tags for the backup.
TagList []*Tag
// The identifier (ID) of the cluster containing the source backup from which the
// new backup was copied.
SourceCluster *string
// The state of the backup.
BackupState BackupState
}
Contains information about a backup of an AWS 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 paramters. A backup that is pending deletion will include the DeleteTimestamp parameter.
type BackupPolicy ¶
type BackupPolicy string
const (
BackupPolicyDefault BackupPolicy = "DEFAULT"
)
Enum values for BackupPolicy
type BackupState ¶
type BackupState string
const ( BackupStateCreate_in_progress BackupState = "CREATE_IN_PROGRESS" BackupStateReady BackupState = "READY" BackupStateDeleted BackupState = "DELETED" BackupStatePending_deletion BackupState = "PENDING_DELETION" )
Enum values for BackupState
type Certificates ¶
type Certificates struct {
// 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
// The cluster certificate issued (signed) by the issuing certificate authority
// (CA) of the cluster's owner.
ClusterCertificate *string
// The HSM hardware certificate issued (signed) by AWS CloudHSM.
AwsHardwareCertificate *string
}
Contains one or more certificates or a certificate signing request (CSR).
type CloudHsmAccessDeniedException ¶
type CloudHsmAccessDeniedException struct {
Message *string
}
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
func (*CloudHsmAccessDeniedException) GetMessage ¶
func (e *CloudHsmAccessDeniedException) GetMessage() string
func (*CloudHsmAccessDeniedException) HasMessage ¶
func (e *CloudHsmAccessDeniedException) HasMessage() bool
type CloudHsmInternalFailureException ¶
type CloudHsmInternalFailureException struct {
Message *string
}
The request was rejected because of an AWS 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
func (*CloudHsmInternalFailureException) GetMessage ¶
func (e *CloudHsmInternalFailureException) GetMessage() string
func (*CloudHsmInternalFailureException) HasMessage ¶
func (e *CloudHsmInternalFailureException) HasMessage() bool
type CloudHsmInvalidRequestException ¶
type CloudHsmInvalidRequestException struct {
Message *string
}
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
func (*CloudHsmInvalidRequestException) GetMessage ¶
func (e *CloudHsmInvalidRequestException) GetMessage() string
func (*CloudHsmInvalidRequestException) HasMessage ¶
func (e *CloudHsmInvalidRequestException) HasMessage() bool
type CloudHsmResourceNotFoundException ¶
type CloudHsmResourceNotFoundException struct {
Message *string
}
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
func (*CloudHsmResourceNotFoundException) GetMessage ¶
func (e *CloudHsmResourceNotFoundException) GetMessage() string
func (*CloudHsmResourceNotFoundException) HasMessage ¶
func (e *CloudHsmResourceNotFoundException) HasMessage() bool
type CloudHsmServiceException ¶
type CloudHsmServiceException struct {
Message *string
}
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
func (*CloudHsmServiceException) GetMessage ¶
func (e *CloudHsmServiceException) GetMessage() string
func (*CloudHsmServiceException) HasMessage ¶
func (e *CloudHsmServiceException) HasMessage() bool
type CloudHsmTagException ¶
type CloudHsmTagException struct {
Message *string
}
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
func (*CloudHsmTagException) GetMessage ¶
func (e *CloudHsmTagException) GetMessage() string
func (*CloudHsmTagException) HasMessage ¶
func (e *CloudHsmTagException) HasMessage() bool
type Cluster ¶
type Cluster struct {
// Contains one or more certificates or a certificate signing request (CSR).
Certificates *Certificates
// The cluster's backup policy.
BackupPolicy BackupPolicy
// The cluster's identifier (ID).
ClusterId *string
// The cluster's state.
State ClusterState
// Contains information about the HSMs in the cluster.
Hsms []*Hsm
// The identifier (ID) of the virtual private cloud (VPC) that contains the
// cluster.
VpcId *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 identifier (ID) of the cluster's security group.
SecurityGroup *string
// The list of tags for the cluster.
TagList []*Tag
// The default password for the cluster's Pre-Crypto Officer (PRECO) user.
PreCoPassword *string
// A map from availability zone to the cluster’s subnet in that availability zone.
SubnetMapping map[string]*string
// A description of the cluster's state.
StateMessage *string
// The type of HSM that the cluster contains.
HsmType *string
// The date and time when the cluster was created.
CreateTimestamp *time.Time
}
Contains information about an AWS CloudHSM cluster.
type ClusterState ¶
type ClusterState string
const ( ClusterStateCreate_in_progress ClusterState = "CREATE_IN_PROGRESS" ClusterStateUninitialized ClusterState = "UNINITIALIZED" ClusterStateInitialize_in_progress ClusterState = "INITIALIZE_IN_PROGRESS" ClusterStateInitialized ClusterState = "INITIALIZED" ClusterStateActive ClusterState = "ACTIVE" ClusterStateUpdate_in_progress ClusterState = "UPDATE_IN_PROGRESS" ClusterStateDelete_in_progress ClusterState = "DELETE_IN_PROGRESS" ClusterStateDeleted ClusterState = "DELETED" ClusterStateDegraded ClusterState = "DEGRADED" )
Enum values for ClusterState
type DestinationBackup ¶
type DestinationBackup struct {
// The identifier (ID) of the cluster containing the source backup from which the
// new backup was copied.
SourceCluster *string
// 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 AWS region that contains the source backup from which the new backup was
// copied.
SourceRegion *string
}
Contains information about the backup that will be copied and created by the CopyBackupToRegion () operation.
type Hsm ¶
type Hsm struct {
// The subnet that contains the HSM's elastic network interface (ENI).
SubnetId *string
// The HSM's identifier (ID).
HsmId *string
// A description of the HSM's state.
StateMessage *string
// The identifier (ID) of the HSM's elastic network interface (ENI).
EniId *string
// The HSM's state.
State HsmState
// The IP address of the HSM's elastic network interface (ENI).
EniIp *string
// The Availability Zone that contains the HSM.
AvailabilityZone *string
// The identifier (ID) of the cluster that contains the HSM.
ClusterId *string
}
Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.