aws-sdk-go: github.com/aws/aws-sdk-go/service/cloudhsmv2 Index | Files | Directories

package cloudhsmv2

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

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

Package Files

api.go doc.go errors.go service.go

Constants

const (
    // BackupStateCreateInProgress is a BackupState enum value
    BackupStateCreateInProgress = "CREATE_IN_PROGRESS"

    // BackupStateReady is a BackupState enum value
    BackupStateReady = "READY"

    // BackupStateDeleted is a BackupState enum value
    BackupStateDeleted = "DELETED"

    // BackupStatePendingDeletion is a BackupState enum value
    BackupStatePendingDeletion = "PENDING_DELETION"
)
const (
    // ClusterStateCreateInProgress is a ClusterState enum value
    ClusterStateCreateInProgress = "CREATE_IN_PROGRESS"

    // ClusterStateUninitialized is a ClusterState enum value
    ClusterStateUninitialized = "UNINITIALIZED"

    // ClusterStateInitializeInProgress is a ClusterState enum value
    ClusterStateInitializeInProgress = "INITIALIZE_IN_PROGRESS"

    // ClusterStateInitialized is a ClusterState enum value
    ClusterStateInitialized = "INITIALIZED"

    // ClusterStateActive is a ClusterState enum value
    ClusterStateActive = "ACTIVE"

    // ClusterStateUpdateInProgress is a ClusterState enum value
    ClusterStateUpdateInProgress = "UPDATE_IN_PROGRESS"

    // ClusterStateDeleteInProgress is a ClusterState enum value
    ClusterStateDeleteInProgress = "DELETE_IN_PROGRESS"

    // ClusterStateDeleted is a ClusterState enum value
    ClusterStateDeleted = "DELETED"

    // ClusterStateDegraded is a ClusterState enum value
    ClusterStateDegraded = "DEGRADED"
)
const (
    // HsmStateCreateInProgress is a HsmState enum value
    HsmStateCreateInProgress = "CREATE_IN_PROGRESS"

    // HsmStateActive is a HsmState enum value
    HsmStateActive = "ACTIVE"

    // HsmStateDegraded is a HsmState enum value
    HsmStateDegraded = "DEGRADED"

    // HsmStateDeleteInProgress is a HsmState enum value
    HsmStateDeleteInProgress = "DELETE_IN_PROGRESS"

    // HsmStateDeleted is a HsmState enum value
    HsmStateDeleted = "DELETED"
)
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"
)
const (
    ServiceName = "cloudhsmv2"  // Name of service.
    EndpointsID = ServiceName   // ID to lookup a service endpoint with.
    ServiceID   = "CloudHSM V2" // ServiceID is a unique identifer of a specific service.
)

Service information constants

const (
    // BackupPolicyDefault is a BackupPolicy enum value
    BackupPolicyDefault = "DEFAULT"
)

type Backup Uses

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 *string `type:"string" enum:"BackupState"`

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

    CopyTimestamp *time.Time `type:"timestamp"`

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

    // The date and time when the backup will be permanently deleted.
    DeleteTimestamp *time.Time `type:"timestamp"`

    SourceBackup *string `type:"string"`

    SourceCluster *string `type:"string"`

    SourceRegion *string `type:"string"`
    // contains filtered or unexported fields
}

Contains information about a backup of an AWS CloudHSM cluster.

func (Backup) GoString Uses

func (s Backup) GoString() string

GoString returns the string representation

func (*Backup) SetBackupId Uses

func (s *Backup) SetBackupId(v string) *Backup

SetBackupId sets the BackupId field's value.

func (*Backup) SetBackupState Uses

func (s *Backup) SetBackupState(v string) *Backup

SetBackupState sets the BackupState field's value.

func (*Backup) SetClusterId Uses

func (s *Backup) SetClusterId(v string) *Backup

SetClusterId sets the ClusterId field's value.

func (*Backup) SetCopyTimestamp Uses

func (s *Backup) SetCopyTimestamp(v time.Time) *Backup

SetCopyTimestamp sets the CopyTimestamp field's value.

func (*Backup) SetCreateTimestamp Uses

func (s *Backup) SetCreateTimestamp(v time.Time) *Backup

SetCreateTimestamp sets the CreateTimestamp field's value.

func (*Backup) SetDeleteTimestamp Uses

func (s *Backup) SetDeleteTimestamp(v time.Time) *Backup

SetDeleteTimestamp sets the DeleteTimestamp field's value.

func (*Backup) SetSourceBackup Uses

func (s *Backup) SetSourceBackup(v string) *Backup

SetSourceBackup sets the SourceBackup field's value.

func (*Backup) SetSourceCluster Uses

func (s *Backup) SetSourceCluster(v string) *Backup

SetSourceCluster sets the SourceCluster field's value.

func (*Backup) SetSourceRegion Uses

func (s *Backup) SetSourceRegion(v string) *Backup

SetSourceRegion sets the SourceRegion field's value.

func (Backup) String Uses

func (s Backup) String() string

String returns the string representation

type Certificates Uses

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

func (Certificates) GoString Uses

func (s Certificates) GoString() string

GoString returns the string representation

func (*Certificates) SetAwsHardwareCertificate Uses

func (s *Certificates) SetAwsHardwareCertificate(v string) *Certificates

SetAwsHardwareCertificate sets the AwsHardwareCertificate field's value.

func (*Certificates) SetClusterCertificate Uses

func (s *Certificates) SetClusterCertificate(v string) *Certificates

SetClusterCertificate sets the ClusterCertificate field's value.

func (*Certificates) SetClusterCsr Uses

func (s *Certificates) SetClusterCsr(v string) *Certificates

SetClusterCsr sets the ClusterCsr field's value.

func (*Certificates) SetHsmCertificate Uses

func (s *Certificates) SetHsmCertificate(v string) *Certificates

SetHsmCertificate sets the HsmCertificate field's value.

func (*Certificates) SetManufacturerHardwareCertificate Uses

func (s *Certificates) SetManufacturerHardwareCertificate(v string) *Certificates

SetManufacturerHardwareCertificate sets the ManufacturerHardwareCertificate field's value.

func (Certificates) String Uses

func (s Certificates) String() string

String returns the string representation

type CloudHSMV2 Uses

type CloudHSMV2 struct {
    *client.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 Uses

func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudHSMV2

New creates a new instance of the CloudHSMV2 client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

// Create a CloudHSMV2 client from just a session.
svc := cloudhsmv2.New(mySession)

// Create a CloudHSMV2 client with additional configuration
svc := cloudhsmv2.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*CloudHSMV2) CopyBackupToRegion Uses

func (c *CloudHSMV2) CopyBackupToRegion(input *CopyBackupToRegionInput) (*CopyBackupToRegionOutput, error)

CopyBackupToRegion API operation for AWS CloudHSM V2.

Copy an AWS CloudHSM cluster backup to a different region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation CopyBackupToRegion for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CopyBackupToRegion

func (*CloudHSMV2) CopyBackupToRegionRequest Uses

func (c *CloudHSMV2) CopyBackupToRegionRequest(input *CopyBackupToRegionInput) (req *request.Request, output *CopyBackupToRegionOutput)

CopyBackupToRegionRequest generates a "aws/request.Request" representing the client's request for the CopyBackupToRegion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CopyBackupToRegion for more information on using the CopyBackupToRegion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CopyBackupToRegionRequest method.
req, resp := client.CopyBackupToRegionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CopyBackupToRegion

func (*CloudHSMV2) CopyBackupToRegionWithContext Uses

func (c *CloudHSMV2) CopyBackupToRegionWithContext(ctx aws.Context, input *CopyBackupToRegionInput, opts ...request.Option) (*CopyBackupToRegionOutput, error)

CopyBackupToRegionWithContext is the same as CopyBackupToRegion with the addition of the ability to pass a context and additional request options.

See CopyBackupToRegion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) CreateCluster Uses

func (c *CloudHSMV2) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)

CreateCluster API operation for AWS CloudHSM V2.

Creates a new AWS CloudHSM cluster.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation CreateCluster for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) CreateClusterRequest Uses

func (c *CloudHSMV2) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)

CreateClusterRequest generates a "aws/request.Request" representing the client's request for the CreateCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateCluster for more information on using the CreateCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateClusterRequest method.
req, resp := client.CreateClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) CreateClusterWithContext Uses

func (c *CloudHSMV2) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)

CreateClusterWithContext is the same as CreateCluster with the addition of the ability to pass a context and additional request options.

See CreateCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) CreateHsm Uses

func (c *CloudHSMV2) CreateHsm(input *CreateHsmInput) (*CreateHsmOutput, error)

CreateHsm API operation for AWS CloudHSM V2.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation CreateHsm for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) CreateHsmRequest Uses

func (c *CloudHSMV2) CreateHsmRequest(input *CreateHsmInput) (req *request.Request, output *CreateHsmOutput)

CreateHsmRequest generates a "aws/request.Request" representing the client's request for the CreateHsm operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateHsm for more information on using the CreateHsm API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateHsmRequest method.
req, resp := client.CreateHsmRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) CreateHsmWithContext Uses

func (c *CloudHSMV2) CreateHsmWithContext(ctx aws.Context, input *CreateHsmInput, opts ...request.Option) (*CreateHsmOutput, error)

CreateHsmWithContext is the same as CreateHsm with the addition of the ability to pass a context and additional request options.

See CreateHsm for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) DeleteBackup Uses

func (c *CloudHSMV2) DeleteBackup(input *DeleteBackupInput) (*DeleteBackupOutput, error)

DeleteBackup API operation for AWS CloudHSM V2.

Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. For more information on restoring a backup, see RestoreBackup

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation DeleteBackup for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteBackup

func (*CloudHSMV2) DeleteBackupRequest Uses

func (c *CloudHSMV2) DeleteBackupRequest(input *DeleteBackupInput) (req *request.Request, output *DeleteBackupOutput)

DeleteBackupRequest generates a "aws/request.Request" representing the client's request for the DeleteBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBackup for more information on using the DeleteBackup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteBackupRequest method.
req, resp := client.DeleteBackupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteBackup

func (*CloudHSMV2) DeleteBackupWithContext Uses

func (c *CloudHSMV2) DeleteBackupWithContext(ctx aws.Context, input *DeleteBackupInput, opts ...request.Option) (*DeleteBackupOutput, error)

DeleteBackupWithContext is the same as DeleteBackup with the addition of the ability to pass a context and additional request options.

See DeleteBackup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) DeleteCluster Uses

func (c *CloudHSMV2) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)

DeleteCluster 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation DeleteCluster for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) DeleteClusterRequest Uses

func (c *CloudHSMV2) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)

DeleteClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteCluster for more information on using the DeleteCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteClusterRequest method.
req, resp := client.DeleteClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) DeleteClusterWithContext Uses

func (c *CloudHSMV2) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)

DeleteClusterWithContext is the same as DeleteCluster with the addition of the ability to pass a context and additional request options.

See DeleteCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) DeleteHsm Uses

func (c *CloudHSMV2) DeleteHsm(input *DeleteHsmInput) (*DeleteHsmOutput, error)

DeleteHsm 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation DeleteHsm for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) DeleteHsmRequest Uses

func (c *CloudHSMV2) DeleteHsmRequest(input *DeleteHsmInput) (req *request.Request, output *DeleteHsmOutput)

DeleteHsmRequest generates a "aws/request.Request" representing the client's request for the DeleteHsm operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteHsm for more information on using the DeleteHsm API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteHsmRequest method.
req, resp := client.DeleteHsmRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) DeleteHsmWithContext Uses

func (c *CloudHSMV2) DeleteHsmWithContext(ctx aws.Context, input *DeleteHsmInput, opts ...request.Option) (*DeleteHsmOutput, error)

DeleteHsmWithContext is the same as DeleteHsm with the addition of the ability to pass a context and additional request options.

See DeleteHsm for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) DescribeBackups Uses

func (c *CloudHSMV2) DescribeBackups(input *DescribeBackupsInput) (*DescribeBackupsOutput, error)

DescribeBackups 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation DescribeBackups for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) DescribeBackupsPages Uses

func (c *CloudHSMV2) DescribeBackupsPages(input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool) error

DescribeBackupsPages iterates over the pages of a DescribeBackups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeBackups method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeBackups operation.
pageNum := 0
err := client.DescribeBackupsPages(params,
    func(page *cloudhsmv2.DescribeBackupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudHSMV2) DescribeBackupsPagesWithContext Uses

func (c *CloudHSMV2) DescribeBackupsPagesWithContext(ctx aws.Context, input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool, opts ...request.Option) error

DescribeBackupsPagesWithContext same as DescribeBackupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) DescribeBackupsRequest Uses

func (c *CloudHSMV2) DescribeBackupsRequest(input *DescribeBackupsInput) (req *request.Request, output *DescribeBackupsOutput)

DescribeBackupsRequest generates a "aws/request.Request" representing the client's request for the DescribeBackups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBackups for more information on using the DescribeBackups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeBackupsRequest method.
req, resp := client.DescribeBackupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) DescribeBackupsWithContext Uses

func (c *CloudHSMV2) DescribeBackupsWithContext(ctx aws.Context, input *DescribeBackupsInput, opts ...request.Option) (*DescribeBackupsOutput, error)

DescribeBackupsWithContext is the same as DescribeBackups with the addition of the ability to pass a context and additional request options.

See DescribeBackups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) DescribeClusters Uses

func (c *CloudHSMV2) DescribeClusters(input *DescribeClustersInput) (*DescribeClustersOutput, error)

DescribeClusters 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation DescribeClusters for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) DescribeClustersPages Uses

func (c *CloudHSMV2) DescribeClustersPages(input *DescribeClustersInput, fn func(*DescribeClustersOutput, bool) bool) error

DescribeClustersPages iterates over the pages of a DescribeClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See DescribeClusters method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a DescribeClusters operation.
pageNum := 0
err := client.DescribeClustersPages(params,
    func(page *cloudhsmv2.DescribeClustersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudHSMV2) DescribeClustersPagesWithContext Uses

func (c *CloudHSMV2) DescribeClustersPagesWithContext(ctx aws.Context, input *DescribeClustersInput, fn func(*DescribeClustersOutput, bool) bool, opts ...request.Option) error

DescribeClustersPagesWithContext same as DescribeClustersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) DescribeClustersRequest Uses

func (c *CloudHSMV2) DescribeClustersRequest(input *DescribeClustersInput) (req *request.Request, output *DescribeClustersOutput)

DescribeClustersRequest generates a "aws/request.Request" representing the client's request for the DescribeClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeClusters for more information on using the DescribeClusters API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeClustersRequest method.
req, resp := client.DescribeClustersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) DescribeClustersWithContext Uses

func (c *CloudHSMV2) DescribeClustersWithContext(ctx aws.Context, input *DescribeClustersInput, opts ...request.Option) (*DescribeClustersOutput, error)

DescribeClustersWithContext is the same as DescribeClusters with the addition of the ability to pass a context and additional request options.

See DescribeClusters for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) InitializeCluster Uses

func (c *CloudHSMV2) InitializeCluster(input *InitializeClusterInput) (*InitializeClusterOutput, error)

InitializeCluster 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation InitializeCluster for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) InitializeClusterRequest Uses

func (c *CloudHSMV2) InitializeClusterRequest(input *InitializeClusterInput) (req *request.Request, output *InitializeClusterOutput)

InitializeClusterRequest generates a "aws/request.Request" representing the client's request for the InitializeCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See InitializeCluster for more information on using the InitializeCluster API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the InitializeClusterRequest method.
req, resp := client.InitializeClusterRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) InitializeClusterWithContext Uses

func (c *CloudHSMV2) InitializeClusterWithContext(ctx aws.Context, input *InitializeClusterInput, opts ...request.Option) (*InitializeClusterOutput, error)

InitializeClusterWithContext is the same as InitializeCluster with the addition of the ability to pass a context and additional request options.

See InitializeCluster for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) ListTags Uses

func (c *CloudHSMV2) ListTags(input *ListTagsInput) (*ListTagsOutput, error)

ListTags 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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation ListTags for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) ListTagsPages Uses

func (c *CloudHSMV2) ListTagsPages(input *ListTagsInput, fn func(*ListTagsOutput, bool) bool) error

ListTagsPages iterates over the pages of a ListTags operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTags method for more information on how to use this operation.

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

// Example iterating over at most 3 pages of a ListTags operation.
pageNum := 0
err := client.ListTagsPages(params,
    func(page *cloudhsmv2.ListTagsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*CloudHSMV2) ListTagsPagesWithContext Uses

func (c *CloudHSMV2) ListTagsPagesWithContext(ctx aws.Context, input *ListTagsInput, fn func(*ListTagsOutput, bool) bool, opts ...request.Option) error

ListTagsPagesWithContext same as ListTagsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) ListTagsRequest Uses

func (c *CloudHSMV2) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)

ListTagsRequest generates a "aws/request.Request" representing the client's request for the ListTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTags for more information on using the ListTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsRequest method.
req, resp := client.ListTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) ListTagsWithContext Uses

func (c *CloudHSMV2) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)

ListTagsWithContext is the same as ListTags with the addition of the ability to pass a context and additional request options.

See ListTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) RestoreBackup Uses

func (c *CloudHSMV2) RestoreBackup(input *RestoreBackupInput) (*RestoreBackupOutput, error)

RestoreBackup API operation for AWS CloudHSM V2.

Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation RestoreBackup for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/RestoreBackup

func (*CloudHSMV2) RestoreBackupRequest Uses

func (c *CloudHSMV2) RestoreBackupRequest(input *RestoreBackupInput) (req *request.Request, output *RestoreBackupOutput)

RestoreBackupRequest generates a "aws/request.Request" representing the client's request for the RestoreBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See RestoreBackup for more information on using the RestoreBackup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the RestoreBackupRequest method.
req, resp := client.RestoreBackupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/RestoreBackup

func (*CloudHSMV2) RestoreBackupWithContext Uses

func (c *CloudHSMV2) RestoreBackupWithContext(ctx aws.Context, input *RestoreBackupInput, opts ...request.Option) (*RestoreBackupOutput, error)

RestoreBackupWithContext is the same as RestoreBackup with the addition of the ability to pass a context and additional request options.

See RestoreBackup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) TagResource Uses

func (c *CloudHSMV2) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS CloudHSM V2.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation TagResource for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) TagResourceRequest Uses

func (c *CloudHSMV2) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) TagResourceWithContext Uses

func (c *CloudHSMV2) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*CloudHSMV2) UntagResource Uses

func (c *CloudHSMV2) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS CloudHSM V2.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS CloudHSM V2's API operation UntagResource for usage and error information.

Returned Error Codes:

* ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException"
The request was rejected because of an AWS CloudHSM internal failure. The
request can be retried.

* ErrCodeCloudHsmServiceException "CloudHsmServiceException"
The request was rejected because an error occurred.

* ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException"
The request was rejected because it refers to a resource that cannot be found.

* ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException"
The request was rejected because it is not a valid request.

* ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException"
The request was rejected because the requester does not have permission to
perform the requested operation.

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

func (*CloudHSMV2) UntagResourceRequest Uses

func (c *CloudHSMV2) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

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

func (*CloudHSMV2) UntagResourceWithContext Uses

func (c *CloudHSMV2) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Cluster Uses

type Cluster struct {

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

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

    // 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 *string `type:"string" enum:"ClusterState"`

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

func (Cluster) GoString Uses

func (s Cluster) GoString() string

GoString returns the string representation

func (*Cluster) SetBackupPolicy Uses

func (s *Cluster) SetBackupPolicy(v string) *Cluster

SetBackupPolicy sets the BackupPolicy field's value.

func (*Cluster) SetCertificates Uses

func (s *Cluster) SetCertificates(v *Certificates) *Cluster

SetCertificates sets the Certificates field's value.

func (*Cluster) SetClusterId Uses

func (s *Cluster) SetClusterId(v string) *Cluster

SetClusterId sets the ClusterId field's value.

func (*Cluster) SetCreateTimestamp Uses

func (s *Cluster) SetCreateTimestamp(v time.Time) *Cluster

SetCreateTimestamp sets the CreateTimestamp field's value.

func (*Cluster) SetHsmType Uses

func (s *Cluster) SetHsmType(v string) *Cluster

SetHsmType sets the HsmType field's value.

func (*Cluster) SetHsms Uses

func (s *Cluster) SetHsms(v []*Hsm) *Cluster

SetHsms sets the Hsms field's value.

func (*Cluster) SetPreCoPassword Uses

func (s *Cluster) SetPreCoPassword(v string) *Cluster

SetPreCoPassword sets the PreCoPassword field's value.

func (*Cluster) SetSecurityGroup Uses

func (s *Cluster) SetSecurityGroup(v string) *Cluster

SetSecurityGroup sets the SecurityGroup field's value.

func (*Cluster) SetSourceBackupId Uses

func (s *Cluster) SetSourceBackupId(v string) *Cluster

SetSourceBackupId sets the SourceBackupId field's value.

func (*Cluster) SetState Uses

func (s *Cluster) SetState(v string) *Cluster

SetState sets the State field's value.

func (*Cluster) SetStateMessage Uses

func (s *Cluster) SetStateMessage(v string) *Cluster

SetStateMessage sets the StateMessage field's value.

func (*Cluster) SetSubnetMapping Uses

func (s *Cluster) SetSubnetMapping(v map[string]*string) *Cluster

SetSubnetMapping sets the SubnetMapping field's value.

func (*Cluster) SetVpcId Uses

func (s *Cluster) SetVpcId(v string) *Cluster

SetVpcId sets the VpcId field's value.

func (Cluster) String Uses

func (s Cluster) String() string

String returns the string representation

type CopyBackupToRegionInput Uses

type CopyBackupToRegionInput struct {

    // The ID of the backup that will be copied to the destination region.
    //
    // BackupId is a required field
    BackupId *string `type:"string" required:"true"`

    // The AWS region that will contain your copied CloudHSM cluster backup.
    //
    // DestinationRegion is a required field
    DestinationRegion *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (CopyBackupToRegionInput) GoString Uses

func (s CopyBackupToRegionInput) GoString() string

GoString returns the string representation

func (*CopyBackupToRegionInput) SetBackupId Uses

func (s *CopyBackupToRegionInput) SetBackupId(v string) *CopyBackupToRegionInput

SetBackupId sets the BackupId field's value.

func (*CopyBackupToRegionInput) SetDestinationRegion Uses

func (s *CopyBackupToRegionInput) SetDestinationRegion(v string) *CopyBackupToRegionInput

SetDestinationRegion sets the DestinationRegion field's value.

func (CopyBackupToRegionInput) String Uses

func (s CopyBackupToRegionInput) String() string

String returns the string representation

func (*CopyBackupToRegionInput) Validate Uses

func (s *CopyBackupToRegionInput) Validate() error

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

type CopyBackupToRegionOutput Uses

type CopyBackupToRegionOutput struct {

    // Information on the backup that will be copied to the destination region,
    // including CreateTimestamp, SourceBackup, SourceCluster, and Source Region.
    // CreateTimestamp of the destination backup will be the same as that of the
    // source backup.
    //
    // You will need to use the sourceBackupID returned in this operation to use
    // the DescribeBackups operation on the backup that will be copied to the destination
    // region.
    DestinationBackup *DestinationBackup `type:"structure"`
    // contains filtered or unexported fields
}

func (CopyBackupToRegionOutput) GoString Uses

func (s CopyBackupToRegionOutput) GoString() string

GoString returns the string representation

func (*CopyBackupToRegionOutput) SetDestinationBackup Uses

func (s *CopyBackupToRegionOutput) SetDestinationBackup(v *DestinationBackup) *CopyBackupToRegionOutput

SetDestinationBackup sets the DestinationBackup field's value.

func (CopyBackupToRegionOutput) String Uses

func (s CopyBackupToRegionOutput) String() string

String returns the string representation

type CreateClusterInput Uses

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
}

func (CreateClusterInput) GoString Uses

func (s CreateClusterInput) GoString() string

GoString returns the string representation

func (*CreateClusterInput) SetHsmType Uses

func (s *CreateClusterInput) SetHsmType(v string) *CreateClusterInput

SetHsmType sets the HsmType field's value.

func (*CreateClusterInput) SetSourceBackupId Uses

func (s *CreateClusterInput) SetSourceBackupId(v string) *CreateClusterInput

SetSourceBackupId sets the SourceBackupId field's value.

func (*CreateClusterInput) SetSubnetIds Uses

func (s *CreateClusterInput) SetSubnetIds(v []*string) *CreateClusterInput

SetSubnetIds sets the SubnetIds field's value.

func (CreateClusterInput) String Uses

func (s CreateClusterInput) String() string

String returns the string representation

func (*CreateClusterInput) Validate Uses

func (s *CreateClusterInput) Validate() error

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

type CreateClusterOutput Uses

type CreateClusterOutput struct {

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

func (CreateClusterOutput) GoString Uses

func (s CreateClusterOutput) GoString() string

GoString returns the string representation

func (*CreateClusterOutput) SetCluster Uses

func (s *CreateClusterOutput) SetCluster(v *Cluster) *CreateClusterOutput

SetCluster sets the Cluster field's value.

func (CreateClusterOutput) String Uses

func (s CreateClusterOutput) String() string

String returns the string representation

type CreateHsmInput Uses

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
}

func (CreateHsmInput) GoString Uses

func (s CreateHsmInput) GoString() string

GoString returns the string representation

func (*CreateHsmInput) SetAvailabilityZone Uses

func (s *CreateHsmInput) SetAvailabilityZone(v string) *CreateHsmInput

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*CreateHsmInput) SetClusterId Uses

func (s *CreateHsmInput) SetClusterId(v string) *CreateHsmInput

SetClusterId sets the ClusterId field's value.

func (*CreateHsmInput) SetIpAddress Uses

func (s *CreateHsmInput) SetIpAddress(v string) *CreateHsmInput

SetIpAddress sets the IpAddress field's value.

func (CreateHsmInput) String Uses

func (s CreateHsmInput) String() string

String returns the string representation

func (*CreateHsmInput) Validate Uses

func (s *CreateHsmInput) Validate() error

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

type CreateHsmOutput Uses

type CreateHsmOutput struct {

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

func (CreateHsmOutput) GoString Uses

func (s CreateHsmOutput) GoString() string

GoString returns the string representation

func (*CreateHsmOutput) SetHsm Uses

func (s *CreateHsmOutput) SetHsm(v *Hsm) *CreateHsmOutput

SetHsm sets the Hsm field's value.

func (CreateHsmOutput) String Uses

func (s CreateHsmOutput) String() string

String returns the string representation

type DeleteBackupInput Uses

type DeleteBackupInput struct {

    // The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups
    // operation.
    //
    // BackupId is a required field
    BackupId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (DeleteBackupInput) GoString Uses

func (s DeleteBackupInput) GoString() string

GoString returns the string representation

func (*DeleteBackupInput) SetBackupId Uses

func (s *DeleteBackupInput) SetBackupId(v string) *DeleteBackupInput

SetBackupId sets the BackupId field's value.

func (DeleteBackupInput) String Uses

func (s DeleteBackupInput) String() string

String returns the string representation

func (*DeleteBackupInput) Validate Uses

func (s *DeleteBackupInput) Validate() error

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

type DeleteBackupOutput Uses

type DeleteBackupOutput struct {

    // Information on the Backup object deleted.
    Backup *Backup `type:"structure"`
    // contains filtered or unexported fields
}

func (DeleteBackupOutput) GoString Uses

func (s DeleteBackupOutput) GoString() string

GoString returns the string representation

func (*DeleteBackupOutput) SetBackup Uses

func (s *DeleteBackupOutput) SetBackup(v *Backup) *DeleteBackupOutput

SetBackup sets the Backup field's value.

func (DeleteBackupOutput) String Uses

func (s DeleteBackupOutput) String() string

String returns the string representation

type DeleteClusterInput Uses

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
}

func (DeleteClusterInput) GoString Uses

func (s DeleteClusterInput) GoString() string

GoString returns the string representation

func (*DeleteClusterInput) SetClusterId Uses

func (s *DeleteClusterInput) SetClusterId(v string) *DeleteClusterInput

SetClusterId sets the ClusterId field's value.

func (DeleteClusterInput) String Uses

func (s DeleteClusterInput) String() string

String returns the string representation

func (*DeleteClusterInput) Validate Uses

func (s *DeleteClusterInput) Validate() error

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

type DeleteClusterOutput Uses

type DeleteClusterOutput struct {

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

func (DeleteClusterOutput) GoString Uses

func (s DeleteClusterOutput) GoString() string

GoString returns the string representation

func (*DeleteClusterOutput) SetCluster Uses

func (s *DeleteClusterOutput) SetCluster(v *Cluster) *DeleteClusterOutput

SetCluster sets the Cluster field's value.

func (DeleteClusterOutput) String Uses

func (s DeleteClusterOutput) String() string

String returns the string representation

type DeleteHsmInput Uses

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
}

func (DeleteHsmInput) GoString Uses

func (s DeleteHsmInput) GoString() string

GoString returns the string representation

func (*DeleteHsmInput) SetClusterId Uses

func (s *DeleteHsmInput) SetClusterId(v string) *DeleteHsmInput

SetClusterId sets the ClusterId field's value.

func (*DeleteHsmInput) SetEniId Uses

func (s *DeleteHsmInput) SetEniId(v string) *DeleteHsmInput

SetEniId sets the EniId field's value.

func (*DeleteHsmInput) SetEniIp Uses

func (s *DeleteHsmInput) SetEniIp(v string) *DeleteHsmInput

SetEniIp sets the EniIp field's value.

func (*DeleteHsmInput) SetHsmId Uses

func (s *DeleteHsmInput) SetHsmId(v string) *DeleteHsmInput

SetHsmId sets the HsmId field's value.

func (DeleteHsmInput) String Uses

func (s DeleteHsmInput) String() string

String returns the string representation

func (*DeleteHsmInput) Validate Uses

func (s *DeleteHsmInput) Validate() error

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

type DeleteHsmOutput Uses

type DeleteHsmOutput struct {

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

func (DeleteHsmOutput) GoString Uses

func (s DeleteHsmOutput) GoString() string

GoString returns the string representation

func (*DeleteHsmOutput) SetHsmId Uses

func (s *DeleteHsmOutput) SetHsmId(v string) *DeleteHsmOutput

SetHsmId sets the HsmId field's value.

func (DeleteHsmOutput) String Uses

func (s DeleteHsmOutput) String() string

String returns the string representation

type DescribeBackupsInput Uses

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 sourceBackupIds filter to return only the backups created from a
    // source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion
    // operation.
    //
    // 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"`

    SortAscending *bool `type:"boolean"`
    // contains filtered or unexported fields
}

func (DescribeBackupsInput) GoString Uses

func (s DescribeBackupsInput) GoString() string

GoString returns the string representation

func (*DescribeBackupsInput) SetFilters Uses

func (s *DescribeBackupsInput) SetFilters(v map[string][]*string) *DescribeBackupsInput

SetFilters sets the Filters field's value.

func (*DescribeBackupsInput) SetMaxResults Uses

func (s *DescribeBackupsInput) SetMaxResults(v int64) *DescribeBackupsInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeBackupsInput) SetNextToken Uses

func (s *DescribeBackupsInput) SetNextToken(v string) *DescribeBackupsInput

SetNextToken sets the NextToken field's value.

func (*DescribeBackupsInput) SetSortAscending Uses

func (s *DescribeBackupsInput) SetSortAscending(v bool) *DescribeBackupsInput

SetSortAscending sets the SortAscending field's value.

func (DescribeBackupsInput) String Uses

func (s DescribeBackupsInput) String() string

String returns the string representation

func (*DescribeBackupsInput) Validate Uses

func (s *DescribeBackupsInput) Validate() error

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

type DescribeBackupsOutput Uses

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
}

func (DescribeBackupsOutput) GoString Uses

func (s DescribeBackupsOutput) GoString() string

GoString returns the string representation

func (*DescribeBackupsOutput) SetBackups Uses

func (s *DescribeBackupsOutput) SetBackups(v []*Backup) *DescribeBackupsOutput

SetBackups sets the Backups field's value.

func (*DescribeBackupsOutput) SetNextToken Uses

func (s *DescribeBackupsOutput) SetNextToken(v string) *DescribeBackupsOutput

SetNextToken sets the NextToken field's value.

func (DescribeBackupsOutput) String Uses

func (s DescribeBackupsOutput) String() string

String returns the string representation

type DescribeClustersInput Uses

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
}

func (DescribeClustersInput) GoString Uses

func (s DescribeClustersInput) GoString() string

GoString returns the string representation

func (*DescribeClustersInput) SetFilters Uses

func (s *DescribeClustersInput) SetFilters(v map[string][]*string) *DescribeClustersInput

SetFilters sets the Filters field's value.

func (*DescribeClustersInput) SetMaxResults Uses

func (s *DescribeClustersInput) SetMaxResults(v int64) *DescribeClustersInput

SetMaxResults sets the MaxResults field's value.

func (*DescribeClustersInput) SetNextToken Uses

func (s *DescribeClustersInput) SetNextToken(v string) *DescribeClustersInput

SetNextToken sets the NextToken field's value.

func (DescribeClustersInput) String Uses

func (s DescribeClustersInput) String() string

String returns the string representation

func (*DescribeClustersInput) Validate Uses

func (s *DescribeClustersInput) Validate() error

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

type DescribeClustersOutput Uses

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
}

func (DescribeClustersOutput) GoString Uses

func (s DescribeClustersOutput) GoString() string

GoString returns the string representation

func (*DescribeClustersOutput) SetClusters Uses

func (s *DescribeClustersOutput) SetClusters(v []*Cluster) *DescribeClustersOutput

SetClusters sets the Clusters field's value.

func (*DescribeClustersOutput) SetNextToken Uses

func (s *DescribeClustersOutput) SetNextToken(v string) *DescribeClustersOutput

SetNextToken sets the NextToken field's value.

func (DescribeClustersOutput) String Uses

func (s DescribeClustersOutput) String() string

String returns the string representation

type DestinationBackup Uses

type DestinationBackup struct {
    CreateTimestamp *time.Time `type:"timestamp"`

    SourceBackup *string `type:"string"`

    SourceCluster *string `type:"string"`

    SourceRegion *string `type:"string"`
    // contains filtered or unexported fields
}

func (DestinationBackup) GoString Uses

func (s DestinationBackup) GoString() string

GoString returns the string representation

func (*DestinationBackup) SetCreateTimestamp Uses

func (s *DestinationBackup) SetCreateTimestamp(v time.Time) *DestinationBackup

SetCreateTimestamp sets the CreateTimestamp field's value.

func (*DestinationBackup) SetSourceBackup Uses

func (s *DestinationBackup) SetSourceBackup(v string) *DestinationBackup

SetSourceBackup sets the SourceBackup field's value.

func (*DestinationBackup) SetSourceCluster Uses

func (s *DestinationBackup) SetSourceCluster(v string) *DestinationBackup

SetSourceCluster sets the SourceCluster field's value.

func (*DestinationBackup) SetSourceRegion Uses

func (s *DestinationBackup) SetSourceRegion(v string) *DestinationBackup

SetSourceRegion sets the SourceRegion field's value.

func (DestinationBackup) String Uses

func (s DestinationBackup) String() string

String returns the string representation

type Hsm Uses

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 *string `type:"string" enum:"HsmState"`

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

func (Hsm) GoString Uses

func (s Hsm) GoString() string

GoString returns the string representation

func (*Hsm) SetAvailabilityZone Uses

func (s *Hsm) SetAvailabilityZone(v string) *Hsm

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*Hsm) SetClusterId Uses

func (s *Hsm) SetClusterId(v string) *Hsm

SetClusterId sets the ClusterId field's value.

func (*Hsm) SetEniId Uses

func (s *Hsm) SetEniId(v string) *Hsm

SetEniId sets the EniId field's value.

func (*Hsm) SetEniIp Uses

func (s *Hsm) SetEniIp(v string) *Hsm

SetEniIp sets the EniIp field's value.

func (*Hsm) SetHsmId Uses

func (s *Hsm) SetHsmId(v string) *Hsm

SetHsmId sets the HsmId field's value.

func (*Hsm) SetState Uses

func (s *Hsm) SetState(v string) *Hsm

SetState sets the State field's value.

func (*Hsm) SetStateMessage Uses

func (s *Hsm) SetStateMessage(v string) *Hsm

SetStateMessage sets the StateMessage field's value.

func (*Hsm) SetSubnetId Uses

func (s *Hsm) SetSubnetId(v string) *Hsm

SetSubnetId sets the SubnetId field's value.

func (Hsm) String Uses

func (s Hsm) String() string

String returns the string representation

type InitializeClusterInput Uses

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
}

func (InitializeClusterInput) GoString Uses

func (s InitializeClusterInput) GoString() string

GoString returns the string representation

func (*InitializeClusterInput) SetClusterId Uses

func (s *InitializeClusterInput) SetClusterId(v string) *InitializeClusterInput

SetClusterId sets the ClusterId field's value.

func (*InitializeClusterInput) SetSignedCert Uses

func (s *InitializeClusterInput) SetSignedCert(v string) *InitializeClusterInput

SetSignedCert sets the SignedCert field's value.

func (*InitializeClusterInput) SetTrustAnchor Uses

func (s *InitializeClusterInput) SetTrustAnchor(v string) *InitializeClusterInput

SetTrustAnchor sets the TrustAnchor field's value.

func (InitializeClusterInput) String Uses

func (s InitializeClusterInput) String() string

String returns the string representation

func (*InitializeClusterInput) Validate Uses

func (s *InitializeClusterInput) Validate() error

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

type InitializeClusterOutput Uses

type InitializeClusterOutput struct {

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

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

func (InitializeClusterOutput) GoString Uses

func (s InitializeClusterOutput) GoString() string

GoString returns the string representation

func (*InitializeClusterOutput) SetState Uses

func (s *InitializeClusterOutput) SetState(v string) *InitializeClusterOutput

SetState sets the State field's value.

func (*InitializeClusterOutput) SetStateMessage Uses

func (s *InitializeClusterOutput) SetStateMessage(v string) *InitializeClusterOutput

SetStateMessage sets the StateMessage field's value.

func (InitializeClusterOutput) String Uses

func (s InitializeClusterOutput) String() string

String returns the string representation

type ListTagsInput Uses

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
}

func (ListTagsInput) GoString Uses

func (s ListTagsInput) GoString() string

GoString returns the string representation

func (*ListTagsInput) SetMaxResults Uses

func (s *ListTagsInput) SetMaxResults(v int64) *ListTagsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsInput) SetNextToken Uses

func (s *ListTagsInput) SetNextToken(v string) *ListTagsInput

SetNextToken sets the NextToken field's value.

func (*ListTagsInput) SetResourceId Uses

func (s *ListTagsInput) SetResourceId(v string) *ListTagsInput

SetResourceId sets the ResourceId field's value.

func (ListTagsInput) String Uses

func (s ListTagsInput) String() string

String returns the string representation

func (*ListTagsInput) Validate Uses

func (s *ListTagsInput) Validate() error

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

type ListTagsOutput Uses

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
}

func (ListTagsOutput) GoString Uses

func (s ListTagsOutput) GoString() string

GoString returns the string representation

func (*ListTagsOutput) SetNextToken Uses

func (s *ListTagsOutput) SetNextToken(v string) *ListTagsOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsOutput) SetTagList Uses

func (s *ListTagsOutput) SetTagList(v []*Tag) *ListTagsOutput

SetTagList sets the TagList field's value.

func (ListTagsOutput) String Uses

func (s ListTagsOutput) String() string

String returns the string representation

type RestoreBackupInput Uses

type RestoreBackupInput struct {

    // The ID of the backup to be restored. To find the ID of a backup, use the
    // DescribeBackups operation.
    //
    // BackupId is a required field
    BackupId *string `type:"string" required:"true"`
    // contains filtered or unexported fields
}

func (RestoreBackupInput) GoString Uses

func (s RestoreBackupInput) GoString() string

GoString returns the string representation

func (*RestoreBackupInput) SetBackupId Uses

func (s *RestoreBackupInput) SetBackupId(v string) *RestoreBackupInput

SetBackupId sets the BackupId field's value.

func (RestoreBackupInput) String Uses

func (s RestoreBackupInput) String() string

String returns the string representation

func (*RestoreBackupInput) Validate Uses

func (s *RestoreBackupInput) Validate() error

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

type RestoreBackupOutput Uses

type RestoreBackupOutput struct {

    // Information on the Backup object created.
    Backup *Backup `type:"structure"`
    // contains filtered or unexported fields
}

func (RestoreBackupOutput) GoString Uses

func (s RestoreBackupOutput) GoString() string

GoString returns the string representation

func (*RestoreBackupOutput) SetBackup Uses

func (s *RestoreBackupOutput) SetBackup(v *Backup) *RestoreBackupOutput

SetBackup sets the Backup field's value.

func (RestoreBackupOutput) String Uses

func (s RestoreBackupOutput) String() string

String returns the string representation

type Tag Uses

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.

func (Tag) GoString Uses

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey Uses

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue Uses

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String Uses

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate Uses

func (s *Tag) Validate() error

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

type TagResourceInput Uses

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
}

func (TagResourceInput) GoString Uses

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceId Uses

func (s *TagResourceInput) SetResourceId(v string) *TagResourceInput

SetResourceId sets the ResourceId field's value.

func (*TagResourceInput) SetTagList Uses

func (s *TagResourceInput) SetTagList(v []*Tag) *TagResourceInput

SetTagList sets the TagList field's value.

func (TagResourceInput) String Uses

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate Uses

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput Uses

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

func (TagResourceOutput) GoString Uses

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String Uses

func (s TagResourceOutput) String() string

String returns the string representation

type UntagResourceInput Uses

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
}

func (UntagResourceInput) GoString Uses

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceId Uses

func (s *UntagResourceInput) SetResourceId(v string) *UntagResourceInput

SetResourceId sets the ResourceId field's value.

func (*UntagResourceInput) SetTagKeyList Uses

func (s *UntagResourceInput) SetTagKeyList(v []*string) *UntagResourceInput

SetTagKeyList sets the TagKeyList field's value.

func (UntagResourceInput) String Uses

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate Uses

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput Uses

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

func (UntagResourceOutput) GoString Uses

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String Uses

func (s UntagResourceOutput) String() string

String returns the string representation

Directories

PathSynopsis
cloudhsmv2ifacePackage cloudhsmv2iface provides an interface to enable mocking the AWS CloudHSM V2 service client for testing your code.

Package cloudhsmv2 imports 10 packages (graph) and is imported by 18 packages. Updated 2019-05-25. Refresh now. Tools for package owners.