cloudhsmv2

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 26, 2018 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package cloudhsmv2 provides the client and types for making API requests to AWS CloudHSM V2.

For more information about AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) and the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/).

See https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28 for more information on this service.

See cloudhsmv2 package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudhsmv2/

Using the Client

To AWS CloudHSM V2 with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS CloudHSM V2 client CloudHSMV2 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudhsmv2/#New

Index

Constants

View Source 
const (

	// ErrCodeCloudHsmAccessDeniedException for service response error code
	// "CloudHsmAccessDeniedException".
	//
	// The request was rejected because the requester does not have permission to
	// perform the requested operation.
	ErrCodeCloudHsmAccessDeniedException = "CloudHsmAccessDeniedException"

	// ErrCodeCloudHsmInternalFailureException for service response error code
	// "CloudHsmInternalFailureException".
	//
	// The request was rejected because of an AWS CloudHSM internal failure. The
	// request can be retried.
	ErrCodeCloudHsmInternalFailureException = "CloudHsmInternalFailureException"

	// ErrCodeCloudHsmInvalidRequestException for service response error code
	// "CloudHsmInvalidRequestException".
	//
	// The request was rejected because it is not a valid request.
	ErrCodeCloudHsmInvalidRequestException = "CloudHsmInvalidRequestException"

	// ErrCodeCloudHsmResourceNotFoundException for service response error code
	// "CloudHsmResourceNotFoundException".
	//
	// The request was rejected because it refers to a resource that cannot be found.
	ErrCodeCloudHsmResourceNotFoundException = "CloudHsmResourceNotFoundException"

	// ErrCodeCloudHsmServiceException for service response error code
	// "CloudHsmServiceException".
	//
	// The request was rejected because an error occurred.
	ErrCodeCloudHsmServiceException = "CloudHsmServiceException"
)
View Source 
const (
	ServiceName = "cloudhsmv2" // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName  // Service ID for Regions and Endpoints metadata.
)

Service information constants

Variables

This section is empty.

Functions

This section is empty.

Types

type Backup 

type Backup struct {

	// The identifier (ID) of the backup.
	//
	// BackupId is a required field
	BackupId *string `type:"string" required:"true"`

	// The state of the backup.
	BackupState BackupState `type:"string" enum:"true"`

	// The identifier (ID) of the cluster that was backed up.
	ClusterId *string `type:"string"`

	// The date and time when the backup was created.
	CreateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`
	// contains filtered or unexported fields
}

Contains information about a backup of an AWS CloudHSM cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Backup

func (Backup) GoString 

func (s Backup) GoString() string

GoString returns the string representation

func (Backup) String 

func (s Backup) String() string

String returns the string representation

type BackupPolicy 

type BackupPolicy string
const (
	BackupPolicyDefault BackupPolicy = "DEFAULT"
)

Enum values for BackupPolicy

func (BackupPolicy) MarshalValue 

func (enum BackupPolicy) MarshalValue() (string, error)

func (BackupPolicy) MarshalValueBuf 

func (enum BackupPolicy) MarshalValueBuf(b []byte) ([]byte, error)

type BackupState 

type BackupState string
const (
	BackupStateCreateInProgress BackupState = "CREATE_IN_PROGRESS"
	BackupStateReady            BackupState = "READY"
	BackupStateDeleted          BackupState = "DELETED"
)

Enum values for BackupState

func (BackupState) MarshalValue 

func (enum BackupState) MarshalValue() (string, error)

func (BackupState) MarshalValueBuf 

func (enum BackupState) MarshalValueBuf(b []byte) ([]byte, error)

type Certificates 

type Certificates struct {

	// The HSM hardware certificate issued (signed) by AWS CloudHSM.
	AwsHardwareCertificate *string `type:"string"`

	// The cluster certificate issued (signed) by the issuing certificate authority
	// (CA) of the cluster's owner.
	ClusterCertificate *string `type:"string"`

	// The cluster's certificate signing request (CSR). The CSR exists only when
	// the cluster's state is UNINITIALIZED.
	ClusterCsr *string `type:"string"`

	// The HSM certificate issued (signed) by the HSM hardware.
	HsmCertificate *string `type:"string"`

	// The HSM hardware certificate issued (signed) by the hardware manufacturer.
	ManufacturerHardwareCertificate *string `type:"string"`
	// contains filtered or unexported fields
}

Contains one or more certificates or a certificate signing request (CSR). Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Certificates

func (Certificates) GoString 

func (s Certificates) GoString() string

GoString returns the string representation

func (Certificates) String 

func (s Certificates) String() string

String returns the string representation

type CloudHSMV2 

type CloudHSMV2 struct {
	*aws.Client
}

CloudHSMV2 provides the API operation methods for making requests to AWS CloudHSM V2. See this package's package overview docs for details on the service.

CloudHSMV2 methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *CloudHSMV2

New creates a new instance of the CloudHSMV2 client with a config.

Example: 

// Create a CloudHSMV2 client from just a config.
svc := cloudhsmv2.New(myConfig)

func (*CloudHSMV2) CreateClusterRequest 

func (c *CloudHSMV2) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest

CreateClusterRequest returns a request value for making API operation for AWS CloudHSM V2.

Creates a new AWS CloudHSM cluster. 

// Example sending a request using the CreateClusterRequest method.
req := client.CreateClusterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateCluster

func (*CloudHSMV2) CreateHsmRequest 

func (c *CloudHSMV2) CreateHsmRequest(input *CreateHsmInput) CreateHsmRequest

CreateHsmRequest returns a request value for making API operation for AWS CloudHSM V2.

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster. 

// Example sending a request using the CreateHsmRequest method.
req := client.CreateHsmRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsm

func (*CloudHSMV2) DeleteClusterRequest 

func (c *CloudHSMV2) DeleteClusterRequest(input *DeleteClusterInput) DeleteClusterRequest

DeleteClusterRequest returns a request value for making API operation for AWS CloudHSM V2.

Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm. 

// Example sending a request using the DeleteClusterRequest method.
req := client.DeleteClusterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteCluster

func (*CloudHSMV2) DeleteHsmRequest 

func (c *CloudHSMV2) DeleteHsmRequest(input *DeleteHsmInput) DeleteHsmRequest

DeleteHsmRequest returns a request value for making API operation for AWS CloudHSM V2.

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters. 

// Example sending a request using the DeleteHsmRequest method.
req := client.DeleteHsmRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsm

func (*CloudHSMV2) DescribeBackupsRequest 

func (c *CloudHSMV2) DescribeBackupsRequest(input *DescribeBackupsInput) DescribeBackupsRequest

DescribeBackupsRequest returns a request value for making API operation for AWS CloudHSM V2.

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get. 

// Example sending a request using the DescribeBackupsRequest method.
req := client.DescribeBackupsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackups

func (*CloudHSMV2) DescribeClustersRequest 

func (c *CloudHSMV2) DescribeClustersRequest(input *DescribeClustersInput) DescribeClustersRequest

DescribeClustersRequest returns a request value for making API operation for AWS CloudHSM V2.

Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get. 

// Example sending a request using the DescribeClustersRequest method.
req := client.DescribeClustersRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClusters

func (*CloudHSMV2) InitializeClusterRequest 

func (c *CloudHSMV2) InitializeClusterRequest(input *InitializeClusterInput) InitializeClusterRequest

InitializeClusterRequest returns a request value for making API operation for AWS CloudHSM V2.

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters. 

// Example sending a request using the InitializeClusterRequest method.
req := client.InitializeClusterRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeCluster

func (*CloudHSMV2) ListTagsRequest 

func (c *CloudHSMV2) ListTagsRequest(input *ListTagsInput) ListTagsRequest

ListTagsRequest returns a request value for making API operation for AWS CloudHSM V2.

Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get. 

// Example sending a request using the ListTagsRequest method.
req := client.ListTagsRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTags

func (*CloudHSMV2) TagResourceRequest 

func (c *CloudHSMV2) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS CloudHSM V2.

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster. 

// Example sending a request using the TagResourceRequest method.
req := client.TagResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResource

func (*CloudHSMV2) UntagResourceRequest 

func (c *CloudHSMV2) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS CloudHSM V2.

Removes the specified tag or tags from the specified AWS CloudHSM cluster. 

// Example sending a request using the UntagResourceRequest method.
req := client.UntagResourceRequest(params)
resp, err := req.Send()
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResource

type Cluster 

type Cluster struct {

	// The cluster's backup policy.
	BackupPolicy BackupPolicy `type:"string" enum:"true"`

	// Contains one or more certificates or a certificate signing request (CSR).
	Certificates *Certificates `type:"structure"`

	// The cluster's identifier (ID).
	ClusterId *string `type:"string"`

	// The date and time when the cluster was created.
	CreateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"`

	// The type of HSM that the cluster contains.
	HsmType *string `type:"string"`

	// Contains information about the HSMs in the cluster.
	Hsms []Hsm `type:"list"`

	// The default password for the cluster's Pre-Crypto Officer (PRECO) user.
	PreCoPassword *string `min:"7" type:"string"`

	// The identifier (ID) of the cluster's security group.
	SecurityGroup *string `type:"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 `type:"string"`

	// The cluster's state.
	State ClusterState `type:"string" enum:"true"`

	// A description of the cluster's state.
	StateMessage *string `type:"string"`

	// A map of the cluster's subnets and their corresponding Availability Zones.
	SubnetMapping map[string]string `type:"map"`

	// The identifier (ID) of the virtual private cloud (VPC) that contains the
	// cluster.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about an AWS CloudHSM cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Cluster

func (Cluster) GoString 

func (s Cluster) GoString() string

GoString returns the string representation

func (Cluster) String 

func (s Cluster) String() string

String returns the string representation

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"
	ClusterStateDeleteInProgress     ClusterState = "DELETE_IN_PROGRESS"
	ClusterStateDeleted              ClusterState = "DELETED"
	ClusterStateDegraded             ClusterState = "DEGRADED"
)

Enum values for ClusterState

func (ClusterState) MarshalValue 

func (enum ClusterState) MarshalValue() (string, error)

func (ClusterState) MarshalValueBuf 

func (enum ClusterState) MarshalValueBuf(b []byte) ([]byte, error)

type CreateClusterInput 

type CreateClusterInput struct {

	// The type of HSM to use in the cluster. Currently the only allowed value is
	// hsm1.medium.
	//
	// HsmType is a required field
	HsmType *string `type:"string" required:"true"`

	// 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.
	SourceBackupId *string `type:"string"`

	// 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.
	//
	// SubnetIds is a required field
	SubnetIds []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateClusterRequest

func (CreateClusterInput) GoString 

func (s CreateClusterInput) GoString() string

GoString returns the string representation

func (CreateClusterInput) String 

func (s CreateClusterInput) String() string

String returns the string representation

func (*CreateClusterInput) Validate 

func (s *CreateClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateClusterOutput 

type CreateClusterOutput struct {

	// Information about the cluster that was created.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateClusterResponse

func (CreateClusterOutput) GoString 

func (s CreateClusterOutput) GoString() string

GoString returns the string representation

func (CreateClusterOutput) SDKResponseMetadata 

func (s CreateClusterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateClusterOutput) String 

func (s CreateClusterOutput) String() string

String returns the string representation

type CreateClusterRequest 

type CreateClusterRequest struct {
	*aws.Request
	Input *CreateClusterInput
	Copy  func(*CreateClusterInput) CreateClusterRequest
}

CreateClusterRequest is a API request type for the CreateCluster API operation.

func (CreateClusterRequest) Send 

func (r CreateClusterRequest) Send() (*CreateClusterOutput, error)

Send marshals and sends the CreateCluster API request.

type CreateHsmInput 

type CreateHsmInput struct {

	// The Availability Zone where you are creating the HSM. To find the cluster's
	// Availability Zones, use DescribeClusters.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `type:"string" required:"true"`

	// The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.
	//
	// ClusterId is a required field
	ClusterId *string `type:"string" required:"true"`

	// The HSM's IP address. If you specify an IP address, use an available address
	// from the subnet that maps to the Availability Zone where you are creating
	// the HSM. If you don't specify an IP address, one is chosen for you from that
	// subnet.
	IpAddress *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsmRequest

func (CreateHsmInput) GoString 

func (s CreateHsmInput) GoString() string

GoString returns the string representation

func (CreateHsmInput) String 

func (s CreateHsmInput) String() string

String returns the string representation

func (*CreateHsmInput) Validate 

func (s *CreateHsmInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateHsmOutput 

type CreateHsmOutput struct {

	// Information about the HSM that was created.
	Hsm *Hsm `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsmResponse

func (CreateHsmOutput) GoString 

func (s CreateHsmOutput) GoString() string

GoString returns the string representation

func (CreateHsmOutput) SDKResponseMetadata 

func (s CreateHsmOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (CreateHsmOutput) String 

func (s CreateHsmOutput) String() string

String returns the string representation

type CreateHsmRequest 

type CreateHsmRequest struct {
	*aws.Request
	Input *CreateHsmInput
	Copy  func(*CreateHsmInput) CreateHsmRequest
}

CreateHsmRequest is a API request type for the CreateHsm API operation.

func (CreateHsmRequest) Send 

func (r CreateHsmRequest) Send() (*CreateHsmOutput, error)

Send marshals and sends the CreateHsm API request.

type DeleteClusterInput 

type DeleteClusterInput struct {

	// The identifier (ID) of the cluster that you are deleting. To find the cluster
	// ID, use DescribeClusters.
	//
	// ClusterId is a required field
	ClusterId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteClusterRequest

func (DeleteClusterInput) GoString 

func (s DeleteClusterInput) GoString() string

GoString returns the string representation

func (DeleteClusterInput) String 

func (s DeleteClusterInput) String() string

String returns the string representation

func (*DeleteClusterInput) Validate 

func (s *DeleteClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteClusterOutput 

type DeleteClusterOutput struct {

	// Information about the cluster that was deleted.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteClusterResponse

func (DeleteClusterOutput) GoString 

func (s DeleteClusterOutput) GoString() string

GoString returns the string representation

func (DeleteClusterOutput) SDKResponseMetadata 

func (s DeleteClusterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteClusterOutput) String 

func (s DeleteClusterOutput) String() string

String returns the string representation

type DeleteClusterRequest 

type DeleteClusterRequest struct {
	*aws.Request
	Input *DeleteClusterInput
	Copy  func(*DeleteClusterInput) DeleteClusterRequest
}

DeleteClusterRequest is a API request type for the DeleteCluster API operation.

func (DeleteClusterRequest) Send 

func (r DeleteClusterRequest) Send() (*DeleteClusterOutput, error)

Send marshals and sends the DeleteCluster API request.

type DeleteHsmInput 

type DeleteHsmInput struct {

	// The identifier (ID) of the cluster that contains the HSM that you are deleting.
	//
	// ClusterId is a required field
	ClusterId *string `type:"string" required:"true"`

	// The identifier (ID) of the elastic network interface (ENI) of the HSM that
	// you are deleting.
	EniId *string `type:"string"`

	// The IP address of the elastic network interface (ENI) of the HSM that you
	// are deleting.
	EniIp *string `type:"string"`

	// The identifier (ID) of the HSM that you are deleting.
	HsmId *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsmRequest

func (DeleteHsmInput) GoString 

func (s DeleteHsmInput) GoString() string

GoString returns the string representation

func (DeleteHsmInput) String 

func (s DeleteHsmInput) String() string

String returns the string representation

func (*DeleteHsmInput) Validate 

func (s *DeleteHsmInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteHsmOutput 

type DeleteHsmOutput struct {

	// The identifier (ID) of the HSM that was deleted.
	HsmId *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsmResponse

func (DeleteHsmOutput) GoString 

func (s DeleteHsmOutput) GoString() string

GoString returns the string representation

func (DeleteHsmOutput) SDKResponseMetadata 

func (s DeleteHsmOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DeleteHsmOutput) String 

func (s DeleteHsmOutput) String() string

String returns the string representation

type DeleteHsmRequest 

type DeleteHsmRequest struct {
	*aws.Request
	Input *DeleteHsmInput
	Copy  func(*DeleteHsmInput) DeleteHsmRequest
}

DeleteHsmRequest is a API request type for the DeleteHsm API operation.

func (DeleteHsmRequest) Send 

func (r DeleteHsmRequest) Send() (*DeleteHsmOutput, error)

Send marshals and sends the DeleteHsm API request.

type DescribeBackupsInput 

type DescribeBackupsInput struct {

	// One or more filters to limit the items returned in the response.
	//
	// Use the backupIds filter to return only the specified backups. Specify backups
	// by their backup identifier (ID).
	//
	// Use the clusterIds filter to return only the backups for the specified clusters.
	// Specify clusters by their cluster identifier (ID).
	//
	// Use the states filter to return only backups that match the specified state.
	Filters map[string][]string `type:"map"`

	// The maximum number of backups to return in the response. When there are more
	// backups than the number you specify, the response contains a NextToken value.
	MaxResults *int64 `min:"1" type:"integer"`

	// The NextToken value that you received in the previous response. Use this
	// value to get more backups.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackupsRequest

func (DescribeBackupsInput) GoString 

func (s DescribeBackupsInput) GoString() string

GoString returns the string representation

func (DescribeBackupsInput) String 

func (s DescribeBackupsInput) String() string

String returns the string representation

func (*DescribeBackupsInput) Validate 

func (s *DescribeBackupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBackupsOutput 

type DescribeBackupsOutput struct {

	// A list of backups.
	Backups []Backup `type:"list"`

	// An opaque string that indicates that the response contains only a subset
	// of backups. Use this value in a subsequent DescribeBackups request to get
	// more backups.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackupsResponse

func (DescribeBackupsOutput) GoString 

func (s DescribeBackupsOutput) GoString() string

GoString returns the string representation

func (DescribeBackupsOutput) SDKResponseMetadata 

func (s DescribeBackupsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeBackupsOutput) String 

func (s DescribeBackupsOutput) String() string

String returns the string representation

type DescribeBackupsPager 

type DescribeBackupsPager struct {
	aws.Pager
}

DescribeBackupsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeBackupsPager) CurrentPage 

func (p *DescribeBackupsPager) CurrentPage() *DescribeBackupsOutput

type DescribeBackupsRequest 

type DescribeBackupsRequest struct {
	*aws.Request
	Input *DescribeBackupsInput
	Copy  func(*DescribeBackupsInput) DescribeBackupsRequest
}

DescribeBackupsRequest is a API request type for the DescribeBackups API operation.

func (*DescribeBackupsRequest) Paginate 

func (p *DescribeBackupsRequest) Paginate(opts ...aws.Option) DescribeBackupsPager

Paginate pages iterates over the pages of a DescribeBackupsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service. 

   // Example iterating over at most 3 pages of a DescribeBackups operation.
		req := client.DescribeBackupsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeBackupsRequest) Send 

func (r DescribeBackupsRequest) Send() (*DescribeBackupsOutput, error)

Send marshals and sends the DescribeBackups API request.

type DescribeClustersInput 

type DescribeClustersInput struct {

	// One or more filters to limit the items returned in the response.
	//
	// Use the clusterIds filter to return only the specified clusters. Specify
	// clusters by their cluster identifier (ID).
	//
	// Use the vpcIds filter to return only the clusters in the specified virtual
	// private clouds (VPCs). Specify VPCs by their VPC identifier (ID).
	//
	// Use the states filter to return only clusters that match the specified state.
	Filters map[string][]string `type:"map"`

	// The maximum number of clusters to return in the response. When there are
	// more clusters than the number you specify, the response contains a NextToken
	// value.
	MaxResults *int64 `min:"1" type:"integer"`

	// The NextToken value that you received in the previous response. Use this
	// value to get more clusters.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClustersRequest

func (DescribeClustersInput) GoString 

func (s DescribeClustersInput) GoString() string

GoString returns the string representation

func (DescribeClustersInput) String 

func (s DescribeClustersInput) String() string

String returns the string representation

func (*DescribeClustersInput) Validate 

func (s *DescribeClustersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeClustersOutput 

type DescribeClustersOutput struct {

	// A list of clusters.
	Clusters []Cluster `type:"list"`

	// An opaque string that indicates that the response contains only a subset
	// of clusters. Use this value in a subsequent DescribeClusters request to get
	// more clusters.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClustersResponse

func (DescribeClustersOutput) GoString 

func (s DescribeClustersOutput) GoString() string

GoString returns the string representation

func (DescribeClustersOutput) SDKResponseMetadata 

func (s DescribeClustersOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (DescribeClustersOutput) String 

func (s DescribeClustersOutput) String() string

String returns the string representation

type DescribeClustersPager 

type DescribeClustersPager struct {
	aws.Pager
}

DescribeClustersPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*DescribeClustersPager) CurrentPage 

func (p *DescribeClustersPager) CurrentPage() *DescribeClustersOutput

type DescribeClustersRequest 

type DescribeClustersRequest struct {
	*aws.Request
	Input *DescribeClustersInput
	Copy  func(*DescribeClustersInput) DescribeClustersRequest
}

DescribeClustersRequest is a API request type for the DescribeClusters API operation.

func (*DescribeClustersRequest) Paginate 

func (p *DescribeClustersRequest) Paginate(opts ...aws.Option) DescribeClustersPager

Paginate pages iterates over the pages of a DescribeClustersRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service. 

   // Example iterating over at most 3 pages of a DescribeClusters operation.
		req := client.DescribeClustersRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (DescribeClustersRequest) Send 

func (r DescribeClustersRequest) Send() (*DescribeClustersOutput, error)

Send marshals and sends the DescribeClusters API request.

type Hsm 

type Hsm struct {

	// The Availability Zone that contains the HSM.
	AvailabilityZone *string `type:"string"`

	// The identifier (ID) of the cluster that contains the HSM.
	ClusterId *string `type:"string"`

	// The identifier (ID) of the HSM's elastic network interface (ENI).
	EniId *string `type:"string"`

	// The IP address of the HSM's elastic network interface (ENI).
	EniIp *string `type:"string"`

	// The HSM's identifier (ID).
	//
	// HsmId is a required field
	HsmId *string `type:"string" required:"true"`

	// The HSM's state.
	State HsmState `type:"string" enum:"true"`

	// A description of the HSM's state.
	StateMessage *string `type:"string"`

	// The subnet that contains the HSM's elastic network interface (ENI).
	SubnetId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Hsm

func (Hsm) GoString 

func (s Hsm) GoString() string

GoString returns the string representation

func (Hsm) String 

func (s Hsm) String() string

String returns the string representation

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) MarshalValue 

func (enum HsmState) MarshalValue() (string, error)

func (HsmState) MarshalValueBuf 

func (enum HsmState) MarshalValueBuf(b []byte) ([]byte, error)

type InitializeClusterInput 

type InitializeClusterInput struct {

	// The identifier (ID) of the cluster that you are claiming. To find the cluster
	// ID, use DescribeClusters.
	//
	// ClusterId is a required field
	ClusterId *string `type:"string" required:"true"`

	// The cluster certificate issued (signed) by your issuing certificate authority
	// (CA). The certificate must be in PEM format and can contain a maximum of
	// 5000 characters.
	//
	// SignedCert is a required field
	SignedCert *string `type:"string" required:"true"`

	// The issuing certificate of the issuing certificate authority (CA) that issued
	// (signed) the cluster certificate. This can be a root (self-signed) certificate
	// or a certificate chain that begins with the certificate that issued the cluster
	// certificate and ends with a root certificate. The certificate or certificate
	// chain must be in PEM format and can contain a maximum of 5000 characters.
	//
	// TrustAnchor is a required field
	TrustAnchor *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeClusterRequest

func (InitializeClusterInput) GoString 

func (s InitializeClusterInput) GoString() string

GoString returns the string representation

func (InitializeClusterInput) String 

func (s InitializeClusterInput) String() string

String returns the string representation

func (*InitializeClusterInput) Validate 

func (s *InitializeClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InitializeClusterOutput 

type InitializeClusterOutput struct {

	// The cluster's state.
	State ClusterState `type:"string" enum:"true"`

	// A description of the cluster's state.
	StateMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeClusterResponse

func (InitializeClusterOutput) GoString 

func (s InitializeClusterOutput) GoString() string

GoString returns the string representation

func (InitializeClusterOutput) SDKResponseMetadata 

func (s InitializeClusterOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (InitializeClusterOutput) String 

func (s InitializeClusterOutput) String() string

String returns the string representation

type InitializeClusterRequest 

type InitializeClusterRequest struct {
	*aws.Request
	Input *InitializeClusterInput
	Copy  func(*InitializeClusterInput) InitializeClusterRequest
}

InitializeClusterRequest is a API request type for the InitializeCluster API operation.

func (InitializeClusterRequest) Send 

func (r InitializeClusterRequest) Send() (*InitializeClusterOutput, error)

Send marshals and sends the InitializeCluster API request.

type ListTagsInput 

type ListTagsInput struct {

	// The maximum number of tags to return in the response. When there are more
	// tags than the number you specify, the response contains a NextToken value.
	MaxResults *int64 `min:"1" type:"integer"`

	// The NextToken value that you received in the previous response. Use this
	// value to get more tags.
	NextToken *string `type:"string"`

	// The cluster identifier (ID) for the cluster whose tags you are getting. To
	// find the cluster ID, use DescribeClusters.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTagsRequest

func (ListTagsInput) GoString 

func (s ListTagsInput) GoString() string

GoString returns the string representation

func (ListTagsInput) String 

func (s ListTagsInput) String() string

String returns the string representation

func (*ListTagsInput) Validate 

func (s *ListTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsOutput 

type ListTagsOutput struct {

	// An opaque string that indicates that the response contains only a subset
	// of tags. Use this value in a subsequent ListTags request to get more tags.
	NextToken *string `type:"string"`

	// A list of tags.
	//
	// TagList is a required field
	TagList []Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTagsResponse

func (ListTagsOutput) GoString 

func (s ListTagsOutput) GoString() string

GoString returns the string representation

func (ListTagsOutput) SDKResponseMetadata 

func (s ListTagsOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (ListTagsOutput) String 

func (s ListTagsOutput) String() string

String returns the string representation

type ListTagsPager 

type ListTagsPager struct {
	aws.Pager
}

ListTagsPager is used to paginate the request. This can be done by calling Next and CurrentPage.

func (*ListTagsPager) CurrentPage 

func (p *ListTagsPager) CurrentPage() *ListTagsOutput

type ListTagsRequest 

type ListTagsRequest struct {
	*aws.Request
	Input *ListTagsInput
	Copy  func(*ListTagsInput) ListTagsRequest
}

ListTagsRequest is a API request type for the ListTags API operation.

func (*ListTagsRequest) Paginate 

func (p *ListTagsRequest) Paginate(opts ...aws.Option) ListTagsPager

Paginate pages iterates over the pages of a ListTagsRequest operation, calling the Next method for each page. Using the paginators Next method will depict whether or not there are more pages.

Note: This operation can generate multiple requests to a service. 

   // Example iterating over at most 3 pages of a ListTags operation.
		req := client.ListTagsRequest(input)
		p := req.Paginate()
		for p.Next() {
			page := p.CurrentPage()
		}

		if err := p.Err(); err != nil {
			return err
		}

func (ListTagsRequest) Send 

func (r ListTagsRequest) Send() (*ListTagsOutput, error)

Send marshals and sends the ListTags API request.

type Tag 

type Tag struct {

	// The key of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a tag. A tag is a key-value pair. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Tag

func (Tag) GoString 

func (s Tag) GoString() string

GoString returns the string representation

func (Tag) String 

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate 

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput 

type TagResourceInput struct {

	// The cluster identifier (ID) for the cluster that you are tagging. To find
	// the cluster ID, use DescribeClusters.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// A list of one or more tags.
	//
	// TagList is a required field
	TagList []Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResourceRequest

func (TagResourceInput) GoString 

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput 

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResourceResponse

func (TagResourceOutput) GoString 

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) SDKResponseMetadata 

func (s TagResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is a API request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send() (*TagResourceOutput, error)

Send marshals and sends the TagResource API request.

type UntagResourceInput 

type UntagResourceInput struct {

	// The cluster identifier (ID) for the cluster whose tags you are removing.
	// To find the cluster ID, use DescribeClusters.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// A list of one or more tag keys for the tags that you are removing. Specify
	// only the tag keys, not the tag values.
	//
	// TagKeyList is a required field
	TagKeyList []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResourceRequest

func (UntagResourceInput) GoString 

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput 

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResourceResponse

func (UntagResourceOutput) GoString 

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) SDKResponseMetadata 

func (s UntagResourceOutput) SDKResponseMetadata() aws.Response

SDKResponseMetdata return sthe response metadata for the API.

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is a API request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send() (*UntagResourceOutput, error)

Send marshals and sends the UntagResource API request.

Source Files

View all Source files

Directories

Path Synopsis
Package cloudhsmv2iface provides an interface to enable mocking the AWS CloudHSM V2 service client for testing your code.
 Package cloudhsmv2iface provides an interface to enable mocking the AWS CloudHSM V2 service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.