cloudhsm

package
v1.13.33-0...-57564ea Latest Latest
Warning

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

Go to latest
Published: Apr 10, 2018 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package cloudhsm provides the client and types for making API requests to Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

See https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30 for more information on this service.

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

Using the Client

To contact Amazon CloudHSM 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 Amazon CloudHSM client CloudHSM for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudhsm/#New

Index

Constants

View Source
const (
	// ClientVersion51 is a ClientVersion enum value
	ClientVersion51 = "5.1"

	// ClientVersion53 is a ClientVersion enum value
	ClientVersion53 = "5.3"
)
View Source
const (
	// CloudHsmObjectStateReady is a CloudHsmObjectState enum value
	CloudHsmObjectStateReady = "READY"

	// CloudHsmObjectStateUpdating is a CloudHsmObjectState enum value
	CloudHsmObjectStateUpdating = "UPDATING"

	// CloudHsmObjectStateDegraded is a CloudHsmObjectState enum value
	CloudHsmObjectStateDegraded = "DEGRADED"
)
View Source
const (
	// HsmStatusPending is a HsmStatus enum value
	HsmStatusPending = "PENDING"

	// HsmStatusRunning is a HsmStatus enum value
	HsmStatusRunning = "RUNNING"

	// HsmStatusUpdating is a HsmStatus enum value
	HsmStatusUpdating = "UPDATING"

	// HsmStatusSuspended is a HsmStatus enum value
	HsmStatusSuspended = "SUSPENDED"

	// HsmStatusTerminating is a HsmStatus enum value
	HsmStatusTerminating = "TERMINATING"

	// HsmStatusTerminated is a HsmStatus enum value
	HsmStatusTerminated = "TERMINATED"

	// HsmStatusDegraded is a HsmStatus enum value
	HsmStatusDegraded = "DEGRADED"
)
View Source
const (

	// ErrCodeCloudHsmInternalException for service response error code
	// "CloudHsmInternalException".
	//
	// Indicates that an internal error occurred.
	ErrCodeCloudHsmInternalException = "CloudHsmInternalException"

	// ErrCodeCloudHsmServiceException for service response error code
	// "CloudHsmServiceException".
	//
	// Indicates that an exception occurred in the AWS CloudHSM service.
	ErrCodeCloudHsmServiceException = "CloudHsmServiceException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// Indicates that one or more of the request parameters are not valid.
	ErrCodeInvalidRequestException = "InvalidRequestException"
)
View Source
const (
	ServiceName = "cloudhsm"  // Service endpoint prefix API calls made to.
	EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata.
)

Service information constants

View Source
const (
	// SubscriptionTypeProduction is a SubscriptionType enum value
	SubscriptionTypeProduction = "PRODUCTION"
)

Specifies the type of subscription for the HSM.

  • PRODUCTION - The HSM is being used in a production environment.

  • TRIAL - The HSM is being used in a product trial.

Variables

This section is empty.

Functions

This section is empty.

Types

type AddTagsToResourceInput

type AddTagsToResourceInput struct {

	// The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// One or more tags.
	//
	// TagList is a required field
	TagList []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (AddTagsToResourceInput) GoString

func (s AddTagsToResourceInput) GoString() string

GoString returns the string representation

func (*AddTagsToResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (*AddTagsToResourceInput) SetTagList

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

SetTagList sets the TagList field's value.

func (AddTagsToResourceInput) String

func (s AddTagsToResourceInput) String() string

String returns the string representation

func (*AddTagsToResourceInput) Validate

func (s *AddTagsToResourceInput) Validate() error

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

type AddTagsToResourceOutput

type AddTagsToResourceOutput struct {

	// The status of the operation.
	//
	// Status is a required field
	Status *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (AddTagsToResourceOutput) GoString

func (s AddTagsToResourceOutput) GoString() string

GoString returns the string representation

func (*AddTagsToResourceOutput) SetStatus

SetStatus sets the Status field's value.

func (AddTagsToResourceOutput) String

func (s AddTagsToResourceOutput) String() string

String returns the string representation

type CloudHSM

type CloudHSM struct {
	*client.Client
}

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

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

func New

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

New creates a new instance of the CloudHSM 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 CloudHSM client from just a session.
svc := cloudhsm.New(mySession)

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

func (*CloudHSM) AddTagsToResource

func (c *CloudHSM) AddTagsToResource(input *AddTagsToResourceInput) (*AddTagsToResourceOutput, error)

AddTagsToResource API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

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

Each tag consists of a key and a value. Tag keys must be unique to each resource.

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 Amazon CloudHSM's API operation AddTagsToResource for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/AddTagsToResource

func (*CloudHSM) AddTagsToResourceRequest

func (c *CloudHSM) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *AddTagsToResourceOutput)

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

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 AddTagsToResource for more information on using the AddTagsToResource 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 AddTagsToResourceRequest method.
req, resp := client.AddTagsToResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/AddTagsToResource

func (*CloudHSM) AddTagsToResourceWithContext

func (c *CloudHSM) AddTagsToResourceWithContext(ctx aws.Context, input *AddTagsToResourceInput, opts ...request.Option) (*AddTagsToResourceOutput, error)

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

See AddTagsToResource 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 (*CloudHSM) CreateHapg

func (c *CloudHSM) CreateHapg(input *CreateHapgInput) (*CreateHapgOutput, error)

CreateHapg API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.

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 Amazon CloudHSM's API operation CreateHapg for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateHapg

func (*CloudHSM) CreateHapgRequest

func (c *CloudHSM) CreateHapgRequest(input *CreateHapgInput) (req *request.Request, output *CreateHapgOutput)

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

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 CreateHapg for more information on using the CreateHapg 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 CreateHapgRequest method.
req, resp := client.CreateHapgRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateHapg

func (*CloudHSM) CreateHapgWithContext

func (c *CloudHSM) CreateHapgWithContext(ctx aws.Context, input *CreateHapgInput, opts ...request.Option) (*CreateHapgOutput, error)

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

See CreateHapg 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 (*CloudHSM) CreateHsm

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

CreateHsm API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Creates an uninitialized HSM instance.

There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center (https://console.aws.amazon.com/support/home), create a new case, and select Account and Billing Support.

It can take up to 20 minutes to create and provision an HSM. You can monitor the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.

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 Amazon CloudHSM's API operation CreateHsm for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateHsm

func (*CloudHSM) CreateHsmRequest

func (c *CloudHSM) 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 successfuly.

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/cloudhsm-2014-05-30/CreateHsm

func (*CloudHSM) CreateHsmWithContext

func (c *CloudHSM) 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 (*CloudHSM) CreateLunaClient

func (c *CloudHSM) CreateLunaClient(input *CreateLunaClientInput) (*CreateLunaClientOutput, error)

CreateLunaClient API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Creates an HSM client.

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 Amazon CloudHSM's API operation CreateLunaClient for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateLunaClient

func (*CloudHSM) CreateLunaClientRequest

func (c *CloudHSM) CreateLunaClientRequest(input *CreateLunaClientInput) (req *request.Request, output *CreateLunaClientOutput)

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

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 CreateLunaClient for more information on using the CreateLunaClient 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 CreateLunaClientRequest method.
req, resp := client.CreateLunaClientRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/CreateLunaClient

func (*CloudHSM) CreateLunaClientWithContext

func (c *CloudHSM) CreateLunaClientWithContext(ctx aws.Context, input *CreateLunaClientInput, opts ...request.Option) (*CreateLunaClientOutput, error)

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

See CreateLunaClient 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 (*CloudHSM) DeleteHapg

func (c *CloudHSM) DeleteHapg(input *DeleteHapgInput) (*DeleteHapgOutput, error)

DeleteHapg API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Deletes a high-availability partition group.

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 Amazon CloudHSM's API operation DeleteHapg for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteHapg

func (*CloudHSM) DeleteHapgRequest

func (c *CloudHSM) DeleteHapgRequest(input *DeleteHapgInput) (req *request.Request, output *DeleteHapgOutput)

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

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 DeleteHapg for more information on using the DeleteHapg 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 DeleteHapgRequest method.
req, resp := client.DeleteHapgRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteHapg

func (*CloudHSM) DeleteHapgWithContext

func (c *CloudHSM) DeleteHapgWithContext(ctx aws.Context, input *DeleteHapgInput, opts ...request.Option) (*DeleteHapgOutput, error)

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

See DeleteHapg 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 (*CloudHSM) DeleteHsm

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

DeleteHsm API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

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 Amazon CloudHSM's API operation DeleteHsm for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteHsm

func (*CloudHSM) DeleteHsmRequest

func (c *CloudHSM) 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 successfuly.

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/cloudhsm-2014-05-30/DeleteHsm

func (*CloudHSM) DeleteHsmWithContext

func (c *CloudHSM) 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 (*CloudHSM) DeleteLunaClient

func (c *CloudHSM) DeleteLunaClient(input *DeleteLunaClientInput) (*DeleteLunaClientOutput, error)

DeleteLunaClient API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Deletes a client.

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 Amazon CloudHSM's API operation DeleteLunaClient for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteLunaClient

func (*CloudHSM) DeleteLunaClientRequest

func (c *CloudHSM) DeleteLunaClientRequest(input *DeleteLunaClientInput) (req *request.Request, output *DeleteLunaClientOutput)

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

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 DeleteLunaClient for more information on using the DeleteLunaClient 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 DeleteLunaClientRequest method.
req, resp := client.DeleteLunaClientRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DeleteLunaClient

func (*CloudHSM) DeleteLunaClientWithContext

func (c *CloudHSM) DeleteLunaClientWithContext(ctx aws.Context, input *DeleteLunaClientInput, opts ...request.Option) (*DeleteLunaClientOutput, error)

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

See DeleteLunaClient 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 (*CloudHSM) DescribeHapg

func (c *CloudHSM) DescribeHapg(input *DescribeHapgInput) (*DescribeHapgOutput, error)

DescribeHapg API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Retrieves information about a high-availability partition group.

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 Amazon CloudHSM's API operation DescribeHapg for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeHapg

func (*CloudHSM) DescribeHapgRequest

func (c *CloudHSM) DescribeHapgRequest(input *DescribeHapgInput) (req *request.Request, output *DescribeHapgOutput)

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

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 DescribeHapg for more information on using the DescribeHapg 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 DescribeHapgRequest method.
req, resp := client.DescribeHapgRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeHapg

func (*CloudHSM) DescribeHapgWithContext

func (c *CloudHSM) DescribeHapgWithContext(ctx aws.Context, input *DescribeHapgInput, opts ...request.Option) (*DescribeHapgOutput, error)

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

See DescribeHapg 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 (*CloudHSM) DescribeHsm

func (c *CloudHSM) DescribeHsm(input *DescribeHsmInput) (*DescribeHsmOutput, error)

DescribeHsm API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

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 Amazon CloudHSM's API operation DescribeHsm for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeHsm

func (*CloudHSM) DescribeHsmRequest

func (c *CloudHSM) DescribeHsmRequest(input *DescribeHsmInput) (req *request.Request, output *DescribeHsmOutput)

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

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 DescribeHsm for more information on using the DescribeHsm 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 DescribeHsmRequest method.
req, resp := client.DescribeHsmRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeHsm

func (*CloudHSM) DescribeHsmWithContext

func (c *CloudHSM) DescribeHsmWithContext(ctx aws.Context, input *DescribeHsmInput, opts ...request.Option) (*DescribeHsmOutput, error)

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

See DescribeHsm 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 (*CloudHSM) DescribeLunaClient

func (c *CloudHSM) DescribeLunaClient(input *DescribeLunaClientInput) (*DescribeLunaClientOutput, error)

DescribeLunaClient API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Retrieves information about an HSM client.

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 Amazon CloudHSM's API operation DescribeLunaClient for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeLunaClient

func (*CloudHSM) DescribeLunaClientRequest

func (c *CloudHSM) DescribeLunaClientRequest(input *DescribeLunaClientInput) (req *request.Request, output *DescribeLunaClientOutput)

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

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 DescribeLunaClient for more information on using the DescribeLunaClient 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 DescribeLunaClientRequest method.
req, resp := client.DescribeLunaClientRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/DescribeLunaClient

func (*CloudHSM) DescribeLunaClientWithContext

func (c *CloudHSM) DescribeLunaClientWithContext(ctx aws.Context, input *DescribeLunaClientInput, opts ...request.Option) (*DescribeLunaClientOutput, error)

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

See DescribeLunaClient 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 (*CloudHSM) GetConfig

func (c *CloudHSM) GetConfig(input *GetConfigInput) (*GetConfigOutput, error)

GetConfig API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.

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 Amazon CloudHSM's API operation GetConfig for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/GetConfig

func (*CloudHSM) GetConfigRequest

func (c *CloudHSM) GetConfigRequest(input *GetConfigInput) (req *request.Request, output *GetConfigOutput)

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

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 GetConfig for more information on using the GetConfig 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 GetConfigRequest method.
req, resp := client.GetConfigRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/GetConfig

func (*CloudHSM) GetConfigWithContext

func (c *CloudHSM) GetConfigWithContext(ctx aws.Context, input *GetConfigInput, opts ...request.Option) (*GetConfigOutput, error)

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

See GetConfig 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 (*CloudHSM) ListAvailableZones

func (c *CloudHSM) ListAvailableZones(input *ListAvailableZonesInput) (*ListAvailableZonesOutput, error)

ListAvailableZones API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Lists the Availability Zones that have available AWS CloudHSM capacity.

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 Amazon CloudHSM's API operation ListAvailableZones for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListAvailableZones

func (*CloudHSM) ListAvailableZonesRequest

func (c *CloudHSM) ListAvailableZonesRequest(input *ListAvailableZonesInput) (req *request.Request, output *ListAvailableZonesOutput)

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

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 ListAvailableZones for more information on using the ListAvailableZones 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 ListAvailableZonesRequest method.
req, resp := client.ListAvailableZonesRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListAvailableZones

func (*CloudHSM) ListAvailableZonesWithContext

func (c *CloudHSM) ListAvailableZonesWithContext(ctx aws.Context, input *ListAvailableZonesInput, opts ...request.Option) (*ListAvailableZonesOutput, error)

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

See ListAvailableZones 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 (*CloudHSM) ListHapgs

func (c *CloudHSM) ListHapgs(input *ListHapgsInput) (*ListHapgsOutput, error)

ListHapgs API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Lists the high-availability partition groups for the account.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.

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 Amazon CloudHSM's API operation ListHapgs for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListHapgs

func (*CloudHSM) ListHapgsRequest

func (c *CloudHSM) ListHapgsRequest(input *ListHapgsInput) (req *request.Request, output *ListHapgsOutput)

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

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 ListHapgs for more information on using the ListHapgs 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 ListHapgsRequest method.
req, resp := client.ListHapgsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListHapgs

func (*CloudHSM) ListHapgsWithContext

func (c *CloudHSM) ListHapgsWithContext(ctx aws.Context, input *ListHapgsInput, opts ...request.Option) (*ListHapgsOutput, error)

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

See ListHapgs 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 (*CloudHSM) ListHsms

func (c *CloudHSM) ListHsms(input *ListHsmsInput) (*ListHsmsOutput, error)

ListHsms API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Retrieves the identifiers of all of the HSMs provisioned for the current customer.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.

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 Amazon CloudHSM's API operation ListHsms for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListHsms

func (*CloudHSM) ListHsmsRequest

func (c *CloudHSM) ListHsmsRequest(input *ListHsmsInput) (req *request.Request, output *ListHsmsOutput)

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

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 ListHsms for more information on using the ListHsms 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 ListHsmsRequest method.
req, resp := client.ListHsmsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListHsms

func (*CloudHSM) ListHsmsWithContext

func (c *CloudHSM) ListHsmsWithContext(ctx aws.Context, input *ListHsmsInput, opts ...request.Option) (*ListHsmsOutput, error)

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

See ListHsms 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 (*CloudHSM) ListLunaClients

func (c *CloudHSM) ListLunaClients(input *ListLunaClientsInput) (*ListLunaClientsOutput, error)

ListLunaClients API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Lists all of the clients.

This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.

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 Amazon CloudHSM's API operation ListLunaClients for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListLunaClients

func (*CloudHSM) ListLunaClientsRequest

func (c *CloudHSM) ListLunaClientsRequest(input *ListLunaClientsInput) (req *request.Request, output *ListLunaClientsOutput)

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

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 ListLunaClients for more information on using the ListLunaClients 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 ListLunaClientsRequest method.
req, resp := client.ListLunaClientsRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListLunaClients

func (*CloudHSM) ListLunaClientsWithContext

func (c *CloudHSM) ListLunaClientsWithContext(ctx aws.Context, input *ListLunaClientsInput, opts ...request.Option) (*ListLunaClientsOutput, error)

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

See ListLunaClients 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 (*CloudHSM) ListTagsForResource

func (c *CloudHSM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Returns a list of all tags for the specified AWS CloudHSM resource.

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 Amazon CloudHSM's API operation ListTagsForResource for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListTagsForResource

func (*CloudHSM) ListTagsForResourceRequest

func (c *CloudHSM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

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

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 ListTagsForResource for more information on using the ListTagsForResource 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 ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ListTagsForResource

func (*CloudHSM) ListTagsForResourceWithContext

func (c *CloudHSM) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

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

See ListTagsForResource 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 (*CloudHSM) ModifyHapg

func (c *CloudHSM) ModifyHapg(input *ModifyHapgInput) (*ModifyHapgOutput, error)

ModifyHapg API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Modifies an existing high-availability partition group.

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 Amazon CloudHSM's API operation ModifyHapg for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyHapg

func (*CloudHSM) ModifyHapgRequest

func (c *CloudHSM) ModifyHapgRequest(input *ModifyHapgInput) (req *request.Request, output *ModifyHapgOutput)

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

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 ModifyHapg for more information on using the ModifyHapg 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 ModifyHapgRequest method.
req, resp := client.ModifyHapgRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyHapg

func (*CloudHSM) ModifyHapgWithContext

func (c *CloudHSM) ModifyHapgWithContext(ctx aws.Context, input *ModifyHapgInput, opts ...request.Option) (*ModifyHapgOutput, error)

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

See ModifyHapg 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 (*CloudHSM) ModifyHsm

func (c *CloudHSM) ModifyHsm(input *ModifyHsmInput) (*ModifyHsmOutput, error)

ModifyHsm API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Modifies an HSM.

This operation can result in the HSM being offline for up to 15 minutes while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.

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 Amazon CloudHSM's API operation ModifyHsm for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyHsm

func (*CloudHSM) ModifyHsmRequest

func (c *CloudHSM) ModifyHsmRequest(input *ModifyHsmInput) (req *request.Request, output *ModifyHsmOutput)

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

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 ModifyHsm for more information on using the ModifyHsm 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 ModifyHsmRequest method.
req, resp := client.ModifyHsmRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyHsm

func (*CloudHSM) ModifyHsmWithContext

func (c *CloudHSM) ModifyHsmWithContext(ctx aws.Context, input *ModifyHsmInput, opts ...request.Option) (*ModifyHsmOutput, error)

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

See ModifyHsm 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 (*CloudHSM) ModifyLunaClient

func (c *CloudHSM) ModifyLunaClient(input *ModifyLunaClientInput) (*ModifyLunaClientOutput, error)

ModifyLunaClient API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Modifies the certificate used by the client.

This action can potentially start a workflow to install the new certificate on the client's HSMs.

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 Amazon CloudHSM's API operation ModifyLunaClient for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyLunaClient

func (*CloudHSM) ModifyLunaClientRequest

func (c *CloudHSM) ModifyLunaClientRequest(input *ModifyLunaClientInput) (req *request.Request, output *ModifyLunaClientOutput)

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

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 ModifyLunaClient for more information on using the ModifyLunaClient 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 ModifyLunaClientRequest method.
req, resp := client.ModifyLunaClientRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/ModifyLunaClient

func (*CloudHSM) ModifyLunaClientWithContext

func (c *CloudHSM) ModifyLunaClientWithContext(ctx aws.Context, input *ModifyLunaClientInput, opts ...request.Option) (*ModifyLunaClientOutput, error)

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

See ModifyLunaClient 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 (*CloudHSM) RemoveTagsFromResource

func (c *CloudHSM) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)

RemoveTagsFromResource API operation for Amazon CloudHSM.

This is documentation for AWS CloudHSM Classic. For more information, see AWS CloudHSM Classic FAQs (http://aws.amazon.com/cloudhsm/faqs-classic/), the AWS CloudHSM Classic User Guide (http://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (http://docs.aws.amazon.com/cloudhsm/classic/APIReference/).

For information about the current version of AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/), the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (http://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

Removes one or more tags from the specified AWS CloudHSM resource.

To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.

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 Amazon CloudHSM's API operation RemoveTagsFromResource for usage and error information.

Returned Error Codes:

  • ErrCodeCloudHsmServiceException "CloudHsmServiceException" Indicates that an exception occurred in the AWS CloudHSM service.

  • ErrCodeCloudHsmInternalException "CloudHsmInternalException" Indicates that an internal error occurred.

  • ErrCodeInvalidRequestException "InvalidRequestException" Indicates that one or more of the request parameters are not valid.

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/RemoveTagsFromResource

func (*CloudHSM) RemoveTagsFromResourceRequest

func (c *CloudHSM) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *RemoveTagsFromResourceOutput)

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

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 RemoveTagsFromResource for more information on using the RemoveTagsFromResource 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 RemoveTagsFromResourceRequest method.
req, resp := client.RemoveTagsFromResourceRequest(params)

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

See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsm-2014-05-30/RemoveTagsFromResource

func (*CloudHSM) RemoveTagsFromResourceWithContext

func (c *CloudHSM) RemoveTagsFromResourceWithContext(ctx aws.Context, input *RemoveTagsFromResourceInput, opts ...request.Option) (*RemoveTagsFromResourceOutput, error)

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

See RemoveTagsFromResource 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 CreateHapgInput

type CreateHapgInput struct {

	// The label of the new high-availability partition group.
	//
	// Label is a required field
	Label *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the CreateHapgRequest action.

func (CreateHapgInput) GoString

func (s CreateHapgInput) GoString() string

GoString returns the string representation

func (*CreateHapgInput) SetLabel

func (s *CreateHapgInput) SetLabel(v string) *CreateHapgInput

SetLabel sets the Label field's value.

func (CreateHapgInput) String

func (s CreateHapgInput) String() string

String returns the string representation

func (*CreateHapgInput) Validate

func (s *CreateHapgInput) Validate() error

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

type CreateHapgOutput

type CreateHapgOutput struct {

	// The ARN of the high-availability partition group.
	HapgArn *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the output of the CreateHAPartitionGroup action.

func (CreateHapgOutput) GoString

func (s CreateHapgOutput) GoString() string

GoString returns the string representation

func (*CreateHapgOutput) SetHapgArn

func (s *CreateHapgOutput) SetHapgArn(v string) *CreateHapgOutput

SetHapgArn sets the HapgArn field's value.

func (CreateHapgOutput) String

func (s CreateHapgOutput) String() string

String returns the string representation

type CreateHsmInput

type CreateHsmInput struct {

	// A user-defined token to ensure idempotence. Subsequent calls to this operation
	// with the same token will be ignored.
	ClientToken *string `locationName:"ClientToken" type:"string"`

	// The IP address to assign to the HSM's ENI.
	//
	// If an IP address is not specified, an IP address will be randomly chosen
	// from the CIDR range of the subnet.
	EniIp *string `locationName:"EniIp" type:"string"`

	// The external ID from IamRoleArn, if present.
	ExternalId *string `locationName:"ExternalId" type:"string"`

	// The ARN of an IAM role to enable the AWS CloudHSM service to allocate an
	// ENI on your behalf.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `locationName:"IamRoleArn" type:"string" required:"true"`

	// The SSH public key to install on the HSM.
	//
	// SshKey is a required field
	SshKey *string `locationName:"SshKey" type:"string" required:"true"`

	// The identifier of the subnet in your VPC in which to place the HSM.
	//
	// SubnetId is a required field
	SubnetId *string `locationName:"SubnetId" type:"string" required:"true"`

	// Specifies the type of subscription for the HSM.
	//
	//    * PRODUCTION - The HSM is being used in a production environment.
	//
	//    * TRIAL - The HSM is being used in a product trial.
	//
	// SubscriptionType is a required field
	SubscriptionType *string `locationName:"SubscriptionType" type:"string" required:"true" enum:"SubscriptionType"`

	// The IP address for the syslog monitoring server. The AWS CloudHSM service
	// only supports one syslog monitoring server.
	SyslogIp *string `locationName:"SyslogIp" type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the CreateHsm operation.

func (CreateHsmInput) GoString

func (s CreateHsmInput) GoString() string

GoString returns the string representation

func (*CreateHsmInput) SetClientToken

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

SetClientToken sets the ClientToken field's value.

func (*CreateHsmInput) SetEniIp

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

SetEniIp sets the EniIp field's value.

func (*CreateHsmInput) SetExternalId

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

SetExternalId sets the ExternalId field's value.

func (*CreateHsmInput) SetIamRoleArn

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

SetIamRoleArn sets the IamRoleArn field's value.

func (*CreateHsmInput) SetSshKey

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

SetSshKey sets the SshKey field's value.

func (*CreateHsmInput) SetSubnetId

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

SetSubnetId sets the SubnetId field's value.

func (*CreateHsmInput) SetSubscriptionType

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

SetSubscriptionType sets the SubscriptionType field's value.

func (*CreateHsmInput) SetSyslogIp

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

SetSyslogIp sets the SyslogIp field's value.

func (CreateHsmInput) String

func (s CreateHsmInput) String() string

String returns the string representation

func (*CreateHsmInput) Validate

func (s *CreateHsmInput) Validate() error

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

type CreateHsmOutput

type CreateHsmOutput struct {

	// The ARN of the HSM.
	HsmArn *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the output of the CreateHsm operation.

func (CreateHsmOutput) GoString

func (s CreateHsmOutput) GoString() string

GoString returns the string representation

func (*CreateHsmOutput) SetHsmArn

func (s *CreateHsmOutput) SetHsmArn(v string) *CreateHsmOutput

SetHsmArn sets the HsmArn field's value.

func (CreateHsmOutput) String

func (s CreateHsmOutput) String() string

String returns the string representation

type CreateLunaClientInput

type CreateLunaClientInput struct {

	// The contents of a Base64-Encoded X.509 v3 certificate to be installed on
	// the HSMs used by this client.
	//
	// Certificate is a required field
	Certificate *string `min:"600" type:"string" required:"true"`

	// The label for the client.
	Label *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the CreateLunaClient action.

func (CreateLunaClientInput) GoString

func (s CreateLunaClientInput) GoString() string

GoString returns the string representation

func (*CreateLunaClientInput) SetCertificate

func (s *CreateLunaClientInput) SetCertificate(v string) *CreateLunaClientInput

SetCertificate sets the Certificate field's value.

func (*CreateLunaClientInput) SetLabel

SetLabel sets the Label field's value.

func (CreateLunaClientInput) String

func (s CreateLunaClientInput) String() string

String returns the string representation

func (*CreateLunaClientInput) Validate

func (s *CreateLunaClientInput) Validate() error

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

type CreateLunaClientOutput

type CreateLunaClientOutput struct {

	// The ARN of the client.
	ClientArn *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the output of the CreateLunaClient action.

func (CreateLunaClientOutput) GoString

func (s CreateLunaClientOutput) GoString() string

GoString returns the string representation

func (*CreateLunaClientOutput) SetClientArn

SetClientArn sets the ClientArn field's value.

func (CreateLunaClientOutput) String

func (s CreateLunaClientOutput) String() string

String returns the string representation

type DeleteHapgInput

type DeleteHapgInput struct {

	// The ARN of the high-availability partition group to delete.
	//
	// HapgArn is a required field
	HapgArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the DeleteHapg action.

func (DeleteHapgInput) GoString

func (s DeleteHapgInput) GoString() string

GoString returns the string representation

func (*DeleteHapgInput) SetHapgArn

func (s *DeleteHapgInput) SetHapgArn(v string) *DeleteHapgInput

SetHapgArn sets the HapgArn field's value.

func (DeleteHapgInput) String

func (s DeleteHapgInput) String() string

String returns the string representation

func (*DeleteHapgInput) Validate

func (s *DeleteHapgInput) Validate() error

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

type DeleteHapgOutput

type DeleteHapgOutput struct {

	// The status of the action.
	//
	// Status is a required field
	Status *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of the DeleteHapg action.

func (DeleteHapgOutput) GoString

func (s DeleteHapgOutput) GoString() string

GoString returns the string representation

func (*DeleteHapgOutput) SetStatus

func (s *DeleteHapgOutput) SetStatus(v string) *DeleteHapgOutput

SetStatus sets the Status field's value.

func (DeleteHapgOutput) String

func (s DeleteHapgOutput) String() string

String returns the string representation

type DeleteHsmInput

type DeleteHsmInput struct {

	// The ARN of the HSM to delete.
	//
	// HsmArn is a required field
	HsmArn *string `locationName:"HsmArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the DeleteHsm operation.

func (DeleteHsmInput) GoString

func (s DeleteHsmInput) GoString() string

GoString returns the string representation

func (*DeleteHsmInput) SetHsmArn

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

SetHsmArn sets the HsmArn field's value.

func (DeleteHsmInput) String

func (s DeleteHsmInput) String() string

String returns the string representation

func (*DeleteHsmInput) Validate

func (s *DeleteHsmInput) Validate() error

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

type DeleteHsmOutput

type DeleteHsmOutput struct {

	// The status of the operation.
	//
	// Status is a required field
	Status *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the output of the DeleteHsm operation.

func (DeleteHsmOutput) GoString

func (s DeleteHsmOutput) GoString() string

GoString returns the string representation

func (*DeleteHsmOutput) SetStatus

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

SetStatus sets the Status field's value.

func (DeleteHsmOutput) String

func (s DeleteHsmOutput) String() string

String returns the string representation

type DeleteLunaClientInput

type DeleteLunaClientInput struct {

	// The ARN of the client to delete.
	//
	// ClientArn is a required field
	ClientArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLunaClientInput) GoString

func (s DeleteLunaClientInput) GoString() string

GoString returns the string representation

func (*DeleteLunaClientInput) SetClientArn

SetClientArn sets the ClientArn field's value.

func (DeleteLunaClientInput) String

func (s DeleteLunaClientInput) String() string

String returns the string representation

func (*DeleteLunaClientInput) Validate

func (s *DeleteLunaClientInput) Validate() error

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

type DeleteLunaClientOutput

type DeleteLunaClientOutput struct {

	// The status of the action.
	//
	// Status is a required field
	Status *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLunaClientOutput) GoString

func (s DeleteLunaClientOutput) GoString() string

GoString returns the string representation

func (*DeleteLunaClientOutput) SetStatus

SetStatus sets the Status field's value.

func (DeleteLunaClientOutput) String

func (s DeleteLunaClientOutput) String() string

String returns the string representation

type DescribeHapgInput

type DescribeHapgInput struct {

	// The ARN of the high-availability partition group to describe.
	//
	// HapgArn is a required field
	HapgArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains the inputs for the DescribeHapg action.

func (DescribeHapgInput) GoString

func (s DescribeHapgInput) GoString() string

GoString returns the string representation

func (*DescribeHapgInput) SetHapgArn

func (s *DescribeHapgInput) SetHapgArn(v string) *DescribeHapgInput

SetHapgArn sets the HapgArn field's value.

func (DescribeHapgInput) String

func (s DescribeHapgInput) String() string

String returns the string representation

func (*DescribeHapgInput) Validate

func (s *DescribeHapgInput) Validate() error

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

type DescribeHapgOutput

type DescribeHapgOutput struct {

	// The ARN of the high-availability partition group.
	HapgArn *string `type:"string"`

	// The serial number of the high-availability partition group.
	HapgSerial *string `type:"string"`

	// Contains a list of ARNs that identify the HSMs.
	HsmsLastActionFailed []*string `type:"list"`

	// Contains a list of ARNs that identify the HSMs.
	HsmsPendingDeletion []*string `type:"list"`

	// Contains a list of ARNs that identify the HSMs.
	HsmsPendingRegistration []*string `type:"list"`

	// The label for the high-availability partition group.
	Label *string `type:"string"`

	// The date and time the high-availability partition group was last modified.
	LastModifiedTimestamp *string `type:"string"`

	// The list of partition serial numbers that belong to the high-availability
	// partition group.
	PartitionSerialList []*string `type:"list"`

	// The state of the high-availability partition group.
	State *string `type:"string" enum:"CloudHsmObjectState"`
	// contains filtered or unexported fields
}

Contains the output of the DescribeHapg action.

func (DescribeHapgOutput) GoString

func (s DescribeHapgOutput) GoString() string

GoString returns the string representation

func (*DescribeHapgOutput) SetHapgArn

func (s *DescribeHapgOutput) SetHapgArn(v string) *DescribeHapgOutput

SetHapgArn sets the HapgArn field's value.

func (*DescribeHapgOutput) SetHapgSerial

func (s *DescribeHapgOutput) SetHapgSerial(v string) *DescribeHapgOutput

SetHapgSerial sets the HapgSerial field's value.

func (*DescribeHapgOutput) SetHsmsLastActionFailed

func (s *DescribeHapgOutput) SetHsmsLastActionFailed(v []*string) *DescribeHapgOutput

SetHsmsLastActionFailed sets the HsmsLastActionFailed field's value.

func (*DescribeHapgOutput) SetHsmsPendingDeletion

func (s *DescribeHapgOutput) SetHsmsPendingDeletion(v []*string) *DescribeHapgOutput

SetHsmsPendingDeletion sets the HsmsPendingDeletion field's value.

func (*DescribeHapgOutput) SetHsmsPendingRegistration

func (s *DescribeHapgOutput) SetHsmsPendingRegistration(v []*string) *DescribeHapgOutput

SetHsmsPendingRegistration sets the HsmsPendingRegistration field's value.

func (*DescribeHapgOutput) SetLabel

SetLabel sets the Label field's value.

func (*DescribeHapgOutput) SetLastModifiedTimestamp

func (s *DescribeHapgOutput) SetLastModifiedTimestamp(v string) *DescribeHapgOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (*DescribeHapgOutput) SetPartitionSerialList

func (s *DescribeHapgOutput) SetPartitionSerialList(v []*string) *DescribeHapgOutput

SetPartitionSerialList sets the PartitionSerialList field's value.

func (*DescribeHapgOutput) SetState

SetState sets the State field's value.

func (DescribeHapgOutput) String

func (s DescribeHapgOutput) String() string

String returns the string representation

type DescribeHsmInput

type DescribeHsmInput struct {

	// The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must
	// be specified.
	HsmArn *string `type:"string"`

	// The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter
	// must be specified.
	HsmSerialNumber *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the DescribeHsm operation.

func (DescribeHsmInput) GoString

func (s DescribeHsmInput) GoString() string

GoString returns the string representation

func (*DescribeHsmInput) SetHsmArn

func (s *DescribeHsmInput) SetHsmArn(v string) *DescribeHsmInput

SetHsmArn sets the HsmArn field's value.

func (*DescribeHsmInput) SetHsmSerialNumber

func (s *DescribeHsmInput) SetHsmSerialNumber(v string) *DescribeHsmInput

SetHsmSerialNumber sets the HsmSerialNumber field's value.

func (DescribeHsmInput) String

func (s DescribeHsmInput) String() string

String returns the string representation

type DescribeHsmOutput

type DescribeHsmOutput struct {

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

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

	// The IP address assigned to the HSM's ENI.
	EniIp *string `type:"string"`

	// The ARN of the HSM.
	HsmArn *string `type:"string"`

	// The HSM model type.
	HsmType *string `type:"string"`

	// The ARN of the IAM role assigned to the HSM.
	IamRoleArn *string `type:"string"`

	// The list of partitions on the HSM.
	Partitions []*string `type:"list"`

	// The serial number of the HSM.
	SerialNumber *string `type:"string"`

	// The date and time that the server certificate was last updated.
	ServerCertLastUpdated *string `type:"string"`

	// The URI of the certificate server.
	ServerCertUri *string `type:"string"`

	// The HSM software version.
	SoftwareVersion *string `type:"string"`

	// The date and time that the SSH key was last updated.
	SshKeyLastUpdated *string `type:"string"`

	// The public SSH key.
	SshPublicKey *string `type:"string"`

	// The status of the HSM.
	Status *string `type:"string" enum:"HsmStatus"`

	// Contains additional information about the status of the HSM.
	StatusDetails *string `type:"string"`

	// The identifier of the subnet that the HSM is in.
	SubnetId *string `type:"string"`

	// The subscription end date.
	SubscriptionEndDate *string `type:"string"`

	// The subscription start date.
	SubscriptionStartDate *string `type:"string"`

	// Specifies the type of subscription for the HSM.
	//
	//    * PRODUCTION - The HSM is being used in a production environment.
	//
	//    * TRIAL - The HSM is being used in a product trial.
	SubscriptionType *string `type:"string" enum:"SubscriptionType"`

	// The name of the HSM vendor.
	VendorName *string `type:"string"`

	// The identifier of the VPC that the HSM is in.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the output of the DescribeHsm operation.

func (DescribeHsmOutput) GoString

func (s DescribeHsmOutput) GoString() string

GoString returns the string representation

func (*DescribeHsmOutput) SetAvailabilityZone

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

SetAvailabilityZone sets the AvailabilityZone field's value.

func (*DescribeHsmOutput) SetEniId

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

SetEniId sets the EniId field's value.

func (*DescribeHsmOutput) SetEniIp

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

SetEniIp sets the EniIp field's value.

func (*DescribeHsmOutput) SetHsmArn

func (s *DescribeHsmOutput) SetHsmArn(v string) *DescribeHsmOutput

SetHsmArn sets the HsmArn field's value.

func (*DescribeHsmOutput) SetHsmType

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

SetHsmType sets the HsmType field's value.

func (*DescribeHsmOutput) SetIamRoleArn

func (s *DescribeHsmOutput) SetIamRoleArn(v string) *DescribeHsmOutput

SetIamRoleArn sets the IamRoleArn field's value.

func (*DescribeHsmOutput) SetPartitions

func (s *DescribeHsmOutput) SetPartitions(v []*string) *DescribeHsmOutput

SetPartitions sets the Partitions field's value.

func (*DescribeHsmOutput) SetSerialNumber

func (s *DescribeHsmOutput) SetSerialNumber(v string) *DescribeHsmOutput

SetSerialNumber sets the SerialNumber field's value.

func (*DescribeHsmOutput) SetServerCertLastUpdated

func (s *DescribeHsmOutput) SetServerCertLastUpdated(v string) *DescribeHsmOutput

SetServerCertLastUpdated sets the ServerCertLastUpdated field's value.

func (*DescribeHsmOutput) SetServerCertUri

func (s *DescribeHsmOutput) SetServerCertUri(v string) *DescribeHsmOutput

SetServerCertUri sets the ServerCertUri field's value.

func (*DescribeHsmOutput) SetSoftwareVersion

func (s *DescribeHsmOutput) SetSoftwareVersion(v string) *DescribeHsmOutput

SetSoftwareVersion sets the SoftwareVersion field's value.

func (*DescribeHsmOutput) SetSshKeyLastUpdated

func (s *DescribeHsmOutput) SetSshKeyLastUpdated(v string) *DescribeHsmOutput

SetSshKeyLastUpdated sets the SshKeyLastUpdated field's value.

func (*DescribeHsmOutput) SetSshPublicKey

func (s *DescribeHsmOutput) SetSshPublicKey(v string) *DescribeHsmOutput

SetSshPublicKey sets the SshPublicKey field's value.

func (*DescribeHsmOutput) SetStatus

func (s *DescribeHsmOutput) SetStatus(v string) *DescribeHsmOutput

SetStatus sets the Status field's value.

func (*DescribeHsmOutput) SetStatusDetails

func (s *DescribeHsmOutput) SetStatusDetails(v string) *DescribeHsmOutput

SetStatusDetails sets the StatusDetails field's value.

func (*DescribeHsmOutput) SetSubnetId

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

SetSubnetId sets the SubnetId field's value.

func (*DescribeHsmOutput) SetSubscriptionEndDate

func (s *DescribeHsmOutput) SetSubscriptionEndDate(v string) *DescribeHsmOutput

SetSubscriptionEndDate sets the SubscriptionEndDate field's value.

func (*DescribeHsmOutput) SetSubscriptionStartDate

func (s *DescribeHsmOutput) SetSubscriptionStartDate(v string) *DescribeHsmOutput

SetSubscriptionStartDate sets the SubscriptionStartDate field's value.

func (*DescribeHsmOutput) SetSubscriptionType

func (s *DescribeHsmOutput) SetSubscriptionType(v string) *DescribeHsmOutput

SetSubscriptionType sets the SubscriptionType field's value.

func (*DescribeHsmOutput) SetVendorName

func (s *DescribeHsmOutput) SetVendorName(v string) *DescribeHsmOutput

SetVendorName sets the VendorName field's value.

func (*DescribeHsmOutput) SetVpcId

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

SetVpcId sets the VpcId field's value.

func (DescribeHsmOutput) String

func (s DescribeHsmOutput) String() string

String returns the string representation

type DescribeLunaClientInput

type DescribeLunaClientInput struct {

	// The certificate fingerprint.
	CertificateFingerprint *string `type:"string"`

	// The ARN of the client.
	ClientArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLunaClientInput) GoString

func (s DescribeLunaClientInput) GoString() string

GoString returns the string representation

func (*DescribeLunaClientInput) SetCertificateFingerprint

func (s *DescribeLunaClientInput) SetCertificateFingerprint(v string) *DescribeLunaClientInput

SetCertificateFingerprint sets the CertificateFingerprint field's value.

func (*DescribeLunaClientInput) SetClientArn

SetClientArn sets the ClientArn field's value.

func (DescribeLunaClientInput) String

func (s DescribeLunaClientInput) String() string

String returns the string representation

type DescribeLunaClientOutput

type DescribeLunaClientOutput struct {

	// The certificate installed on the HSMs used by this client.
	Certificate *string `min:"600" type:"string"`

	// The certificate fingerprint.
	CertificateFingerprint *string `type:"string"`

	// The ARN of the client.
	ClientArn *string `type:"string"`

	// The label of the client.
	Label *string `type:"string"`

	// The date and time the client was last modified.
	LastModifiedTimestamp *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLunaClientOutput) GoString

func (s DescribeLunaClientOutput) GoString() string

GoString returns the string representation

func (*DescribeLunaClientOutput) SetCertificate

SetCertificate sets the Certificate field's value.

func (*DescribeLunaClientOutput) SetCertificateFingerprint

func (s *DescribeLunaClientOutput) SetCertificateFingerprint(v string) *DescribeLunaClientOutput

SetCertificateFingerprint sets the CertificateFingerprint field's value.

func (*DescribeLunaClientOutput) SetClientArn

SetClientArn sets the ClientArn field's value.

func (*DescribeLunaClientOutput) SetLabel

SetLabel sets the Label field's value.

func (*DescribeLunaClientOutput) SetLastModifiedTimestamp

func (s *DescribeLunaClientOutput) SetLastModifiedTimestamp(v string) *DescribeLunaClientOutput

SetLastModifiedTimestamp sets the LastModifiedTimestamp field's value.

func (DescribeLunaClientOutput) String

func (s DescribeLunaClientOutput) String() string

String returns the string representation

type GetConfigInput

type GetConfigInput struct {

	// The ARN of the client.
	//
	// ClientArn is a required field
	ClientArn *string `type:"string" required:"true"`

	// The client version.
	//
	// ClientVersion is a required field
	ClientVersion *string `type:"string" required:"true" enum:"ClientVersion"`

	// A list of ARNs that identify the high-availability partition groups that
	// are associated with the client.
	//
	// HapgList is a required field
	HapgList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (GetConfigInput) GoString

func (s GetConfigInput) GoString() string

GoString returns the string representation

func (*GetConfigInput) SetClientArn

func (s *GetConfigInput) SetClientArn(v string) *GetConfigInput

SetClientArn sets the ClientArn field's value.

func (*GetConfigInput) SetClientVersion

func (s *GetConfigInput) SetClientVersion(v string) *GetConfigInput

SetClientVersion sets the ClientVersion field's value.

func (*GetConfigInput) SetHapgList

func (s *GetConfigInput) SetHapgList(v []*string) *GetConfigInput

SetHapgList sets the HapgList field's value.

func (GetConfigInput) String

func (s GetConfigInput) String() string

String returns the string representation

func (*GetConfigInput) Validate

func (s *GetConfigInput) Validate() error

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

type GetConfigOutput

type GetConfigOutput struct {

	// The certificate file containing the server.pem files of the HSMs.
	ConfigCred *string `type:"string"`

	// The chrystoki.conf configuration file.
	ConfigFile *string `type:"string"`

	// The type of credentials.
	ConfigType *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetConfigOutput) GoString

func (s GetConfigOutput) GoString() string

GoString returns the string representation

func (*GetConfigOutput) SetConfigCred

func (s *GetConfigOutput) SetConfigCred(v string) *GetConfigOutput

SetConfigCred sets the ConfigCred field's value.

func (*GetConfigOutput) SetConfigFile

func (s *GetConfigOutput) SetConfigFile(v string) *GetConfigOutput

SetConfigFile sets the ConfigFile field's value.

func (*GetConfigOutput) SetConfigType

func (s *GetConfigOutput) SetConfigType(v string) *GetConfigOutput

SetConfigType sets the ConfigType field's value.

func (GetConfigOutput) String

func (s GetConfigOutput) String() string

String returns the string representation

type ListAvailableZonesInput

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

Contains the inputs for the ListAvailableZones action.

func (ListAvailableZonesInput) GoString

func (s ListAvailableZonesInput) GoString() string

GoString returns the string representation

func (ListAvailableZonesInput) String

func (s ListAvailableZonesInput) String() string

String returns the string representation

type ListAvailableZonesOutput

type ListAvailableZonesOutput struct {

	// The list of Availability Zones that have available AWS CloudHSM capacity.
	AZList []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListAvailableZonesOutput) GoString

func (s ListAvailableZonesOutput) GoString() string

GoString returns the string representation

func (*ListAvailableZonesOutput) SetAZList

SetAZList sets the AZList field's value.

func (ListAvailableZonesOutput) String

func (s ListAvailableZonesOutput) String() string

String returns the string representation

type ListHapgsInput

type ListHapgsInput struct {

	// The NextToken value from a previous call to ListHapgs. Pass null if this
	// is the first call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListHapgsInput) GoString

func (s ListHapgsInput) GoString() string

GoString returns the string representation

func (*ListHapgsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListHapgsInput) String

func (s ListHapgsInput) String() string

String returns the string representation

type ListHapgsOutput

type ListHapgsOutput struct {

	// The list of high-availability partition groups.
	//
	// HapgList is a required field
	HapgList []*string `type:"list" required:"true"`

	// If not null, more results are available. Pass this value to ListHapgs to
	// retrieve the next set of items.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListHapgsOutput) GoString

func (s ListHapgsOutput) GoString() string

GoString returns the string representation

func (*ListHapgsOutput) SetHapgList

func (s *ListHapgsOutput) SetHapgList(v []*string) *ListHapgsOutput

SetHapgList sets the HapgList field's value.

func (*ListHapgsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListHapgsOutput) String

func (s ListHapgsOutput) String() string

String returns the string representation

type ListHsmsInput

type ListHsmsInput struct {

	// The NextToken value from a previous call to ListHsms. Pass null if this is
	// the first call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListHsmsInput) GoString

func (s ListHsmsInput) GoString() string

GoString returns the string representation

func (*ListHsmsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListHsmsInput) String

func (s ListHsmsInput) String() string

String returns the string representation

type ListHsmsOutput

type ListHsmsOutput struct {

	// The list of ARNs that identify the HSMs.
	HsmList []*string `type:"list"`

	// If not null, more results are available. Pass this value to ListHsms to retrieve
	// the next set of items.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the output of the ListHsms operation.

func (ListHsmsOutput) GoString

func (s ListHsmsOutput) GoString() string

GoString returns the string representation

func (*ListHsmsOutput) SetHsmList

func (s *ListHsmsOutput) SetHsmList(v []*string) *ListHsmsOutput

SetHsmList sets the HsmList field's value.

func (*ListHsmsOutput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListHsmsOutput) String

func (s ListHsmsOutput) String() string

String returns the string representation

type ListLunaClientsInput

type ListLunaClientsInput struct {

	// The NextToken value from a previous call to ListLunaClients. Pass null if
	// this is the first call.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListLunaClientsInput) GoString

func (s ListLunaClientsInput) GoString() string

GoString returns the string representation

func (*ListLunaClientsInput) SetNextToken

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

SetNextToken sets the NextToken field's value.

func (ListLunaClientsInput) String

func (s ListLunaClientsInput) String() string

String returns the string representation

type ListLunaClientsOutput

type ListLunaClientsOutput struct {

	// The list of clients.
	//
	// ClientList is a required field
	ClientList []*string `type:"list" required:"true"`

	// If not null, more results are available. Pass this to ListLunaClients to
	// retrieve the next set of items.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListLunaClientsOutput) GoString

func (s ListLunaClientsOutput) GoString() string

GoString returns the string representation

func (*ListLunaClientsOutput) SetClientList

func (s *ListLunaClientsOutput) SetClientList(v []*string) *ListLunaClientsOutput

SetClientList sets the ClientList field's value.

func (*ListLunaClientsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListLunaClientsOutput) String

func (s ListLunaClientsOutput) String() string

String returns the string representation

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// One or more tags.
	//
	// TagList is a required field
	TagList []*Tag `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation

func (*ListTagsForResourceOutput) SetTagList

SetTagList sets the TagList field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ModifyHapgInput

type ModifyHapgInput struct {

	// The ARN of the high-availability partition group to modify.
	//
	// HapgArn is a required field
	HapgArn *string `type:"string" required:"true"`

	// The new label for the high-availability partition group.
	Label *string `type:"string"`

	// The list of partition serial numbers to make members of the high-availability
	// partition group.
	PartitionSerialList []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ModifyHapgInput) GoString

func (s ModifyHapgInput) GoString() string

GoString returns the string representation

func (*ModifyHapgInput) SetHapgArn

func (s *ModifyHapgInput) SetHapgArn(v string) *ModifyHapgInput

SetHapgArn sets the HapgArn field's value.

func (*ModifyHapgInput) SetLabel

func (s *ModifyHapgInput) SetLabel(v string) *ModifyHapgInput

SetLabel sets the Label field's value.

func (*ModifyHapgInput) SetPartitionSerialList

func (s *ModifyHapgInput) SetPartitionSerialList(v []*string) *ModifyHapgInput

SetPartitionSerialList sets the PartitionSerialList field's value.

func (ModifyHapgInput) String

func (s ModifyHapgInput) String() string

String returns the string representation

func (*ModifyHapgInput) Validate

func (s *ModifyHapgInput) Validate() error

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

type ModifyHapgOutput

type ModifyHapgOutput struct {

	// The ARN of the high-availability partition group.
	HapgArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyHapgOutput) GoString

func (s ModifyHapgOutput) GoString() string

GoString returns the string representation

func (*ModifyHapgOutput) SetHapgArn

func (s *ModifyHapgOutput) SetHapgArn(v string) *ModifyHapgOutput

SetHapgArn sets the HapgArn field's value.

func (ModifyHapgOutput) String

func (s ModifyHapgOutput) String() string

String returns the string representation

type ModifyHsmInput

type ModifyHsmInput struct {

	// The new IP address for the elastic network interface (ENI) attached to the
	// HSM.
	//
	// If the HSM is moved to a different subnet, and an IP address is not specified,
	// an IP address will be randomly chosen from the CIDR range of the new subnet.
	EniIp *string `locationName:"EniIp" type:"string"`

	// The new external ID.
	ExternalId *string `locationName:"ExternalId" type:"string"`

	// The ARN of the HSM to modify.
	//
	// HsmArn is a required field
	HsmArn *string `locationName:"HsmArn" type:"string" required:"true"`

	// The new IAM role ARN.
	IamRoleArn *string `locationName:"IamRoleArn" type:"string"`

	// The new identifier of the subnet that the HSM is in. The new subnet must
	// be in the same Availability Zone as the current subnet.
	SubnetId *string `locationName:"SubnetId" type:"string"`

	// The new IP address for the syslog monitoring server. The AWS CloudHSM service
	// only supports one syslog monitoring server.
	SyslogIp *string `locationName:"SyslogIp" type:"string"`
	// contains filtered or unexported fields
}

Contains the inputs for the ModifyHsm operation.

func (ModifyHsmInput) GoString

func (s ModifyHsmInput) GoString() string

GoString returns the string representation

func (*ModifyHsmInput) SetEniIp

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

SetEniIp sets the EniIp field's value.

func (*ModifyHsmInput) SetExternalId

func (s *ModifyHsmInput) SetExternalId(v string) *ModifyHsmInput

SetExternalId sets the ExternalId field's value.

func (*ModifyHsmInput) SetHsmArn

func (s *ModifyHsmInput) SetHsmArn(v string) *ModifyHsmInput

SetHsmArn sets the HsmArn field's value.

func (*ModifyHsmInput) SetIamRoleArn

func (s *ModifyHsmInput) SetIamRoleArn(v string) *ModifyHsmInput

SetIamRoleArn sets the IamRoleArn field's value.

func (*ModifyHsmInput) SetSubnetId

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

SetSubnetId sets the SubnetId field's value.

func (*ModifyHsmInput) SetSyslogIp

func (s *ModifyHsmInput) SetSyslogIp(v string) *ModifyHsmInput

SetSyslogIp sets the SyslogIp field's value.

func (ModifyHsmInput) String

func (s ModifyHsmInput) String() string

String returns the string representation

func (*ModifyHsmInput) Validate

func (s *ModifyHsmInput) Validate() error

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

type ModifyHsmOutput

type ModifyHsmOutput struct {

	// The ARN of the HSM.
	HsmArn *string `type:"string"`
	// contains filtered or unexported fields
}

Contains the output of the ModifyHsm operation.

func (ModifyHsmOutput) GoString

func (s ModifyHsmOutput) GoString() string

GoString returns the string representation

func (*ModifyHsmOutput) SetHsmArn

func (s *ModifyHsmOutput) SetHsmArn(v string) *ModifyHsmOutput

SetHsmArn sets the HsmArn field's value.

func (ModifyHsmOutput) String

func (s ModifyHsmOutput) String() string

String returns the string representation

type ModifyLunaClientInput

type ModifyLunaClientInput struct {

	// The new certificate for the client.
	//
	// Certificate is a required field
	Certificate *string `min:"600" type:"string" required:"true"`

	// The ARN of the client.
	//
	// ClientArn is a required field
	ClientArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ModifyLunaClientInput) GoString

func (s ModifyLunaClientInput) GoString() string

GoString returns the string representation

func (*ModifyLunaClientInput) SetCertificate

func (s *ModifyLunaClientInput) SetCertificate(v string) *ModifyLunaClientInput

SetCertificate sets the Certificate field's value.

func (*ModifyLunaClientInput) SetClientArn

SetClientArn sets the ClientArn field's value.

func (ModifyLunaClientInput) String

func (s ModifyLunaClientInput) String() string

String returns the string representation

func (*ModifyLunaClientInput) Validate

func (s *ModifyLunaClientInput) Validate() error

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

type ModifyLunaClientOutput

type ModifyLunaClientOutput struct {

	// The ARN of the client.
	ClientArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyLunaClientOutput) GoString

func (s ModifyLunaClientOutput) GoString() string

GoString returns the string representation

func (*ModifyLunaClientOutput) SetClientArn

SetClientArn sets the ClientArn field's value.

func (ModifyLunaClientOutput) String

func (s ModifyLunaClientOutput) String() string

String returns the string representation

type RemoveTagsFromResourceInput

type RemoveTagsFromResourceInput struct {

	// The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The tag key or keys to remove.
	//
	// Specify only the tag key to remove (not the value). To overwrite the value
	// for an existing tag, use AddTagsToResource.
	//
	// TagKeyList is a required field
	TagKeyList []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveTagsFromResourceInput) GoString

func (s RemoveTagsFromResourceInput) GoString() string

GoString returns the string representation

func (*RemoveTagsFromResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (*RemoveTagsFromResourceInput) SetTagKeyList

SetTagKeyList sets the TagKeyList field's value.

func (RemoveTagsFromResourceInput) String

String returns the string representation

func (*RemoveTagsFromResourceInput) Validate

func (s *RemoveTagsFromResourceInput) Validate() error

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

type RemoveTagsFromResourceOutput

type RemoveTagsFromResourceOutput struct {

	// The status of the operation.
	//
	// Status is a required field
	Status *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RemoveTagsFromResourceOutput) GoString

func (s RemoveTagsFromResourceOutput) GoString() string

GoString returns the string representation

func (*RemoveTagsFromResourceOutput) SetStatus

SetStatus sets the Status field's value.

func (RemoveTagsFromResourceOutput) String

String returns the string representation

type Tag

type Tag struct {

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

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

A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation

func (*Tag) SetKey

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

SetKey sets the Key field's value.

func (*Tag) SetValue

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

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

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

Directories

Path Synopsis
Package cloudhsmiface provides an interface to enable mocking the Amazon CloudHSM service client for testing your code.
Package cloudhsmiface provides an interface to enable mocking the Amazon CloudHSM service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL