package types

import "github.com/aws/aws-sdk-go-v2/service/cloudhsmv2/types"

Index

Types

type Backup

type Backup struct {

	// The identifier (ID) of the backup.
	//
	// This member is required.
	BackupId *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 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 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 HSM hardware certificate issued (signed) by AWS 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 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 (*CloudHsmAccessDeniedException) ErrorCode

func (e *CloudHsmAccessDeniedException) ErrorCode() string

func (*CloudHsmAccessDeniedException) ErrorFault

func (*CloudHsmAccessDeniedException) ErrorMessage

func (e *CloudHsmAccessDeniedException) ErrorMessage() string

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 (*CloudHsmInternalFailureException) ErrorCode

func (*CloudHsmInternalFailureException) ErrorFault

func (*CloudHsmInternalFailureException) ErrorMessage

func (e *CloudHsmInternalFailureException) ErrorMessage() string

type CloudHsmInvalidRequestException

type CloudHsmInvalidRequestException struct {
	Message *string
}

The request was rejected because it is not a valid request.

func (*CloudHsmInvalidRequestException) Error

func (*CloudHsmInvalidRequestException) ErrorCode

func (e *CloudHsmInvalidRequestException) ErrorCode() string

func (*CloudHsmInvalidRequestException) ErrorFault

func (*CloudHsmInvalidRequestException) ErrorMessage

func (e *CloudHsmInvalidRequestException) ErrorMessage() string

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 (*CloudHsmResourceNotFoundException) ErrorCode

func (*CloudHsmResourceNotFoundException) ErrorFault

func (*CloudHsmResourceNotFoundException) ErrorMessage

func (e *CloudHsmResourceNotFoundException) ErrorMessage() string

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

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

type Cluster

type Cluster struct {

	// The cluster's backup policy.
	BackupPolicy BackupPolicy

	// 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

	// Contains information about the HSMs in the cluster.
	Hsms []*Hsm

	// 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 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 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 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 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 information about a hardware security module (HSM) in an AWS CloudHSM cluster.

type HsmState

type HsmState string
const (
	HsmStateCreate_in_progress HsmState = "CREATE_IN_PROGRESS"
	HsmStateActive             HsmState = "ACTIVE"
	HsmStateDegraded           HsmState = "DEGRADED"
	HsmStateDelete_in_progress HsmState = "DELETE_IN_PROGRESS"
	HsmStateDeleted            HsmState = "DELETED"
)

Enum values for HsmState

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 a tag. A tag is a key-value pair.

Source Files

enums.go errors.go types.go

Version
v0.27.0
Published
Oct 17, 2020
Platform
js/wasm
Imports
3 packages
Last checked
6 hours ago

Tools for package owners.