cloudhsm

package
v0.23.3 Latest Latest
Warning

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

Go to latest
Published: Jun 25, 2020 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package cloudhsm provides the client and types for making API requests to 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 use 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 CloudHSM client 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 (
	ServiceName = "CloudHSM" // Service's name
	ServiceID   = "CloudHSM" // Service's identifier
	EndpointsID = "cloudhsm" // Service's Endpoint identifier
)
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"
)

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

func (s AddTagsToResourceOutput) String() string

String returns the string representation

type AddTagsToResourceRequest

type AddTagsToResourceRequest struct {
	*aws.Request
	Input *AddTagsToResourceInput
	Copy  func(*AddTagsToResourceInput) AddTagsToResourceRequest
}

AddTagsToResourceRequest is the request type for the AddTagsToResource API operation.

func (AddTagsToResourceRequest) Send

Send marshals and sends the AddTagsToResource API request.

type AddTagsToResourceResponse added in v0.23.2

type AddTagsToResourceResponse struct {
	*AddTagsToResourceOutput
	// contains filtered or unexported fields
}

AddTagsToResourceResponse is the response type for the AddTagsToResource API operation.

func (*AddTagsToResourceResponse) SDKResponseMetdata added in v0.23.2

func (r *AddTagsToResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the AddTagsToResource request.

type Client added in v0.23.2

type Client struct {
	*aws.Client
}

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

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

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

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

func (*Client) AddTagsToResourceRequest added in v0.23.2

func (c *Client) AddTagsToResourceRequest(input *AddTagsToResourceInput) AddTagsToResourceRequest

AddTagsToResourceRequest returns a request value for making 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.

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

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

func (*Client) CreateHapgRequest added in v0.23.2

func (c *Client) CreateHapgRequest(input *CreateHapgInput) CreateHapgRequest

CreateHapgRequest returns a request value for making 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.

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

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

func (*Client) CreateHsmRequest added in v0.23.2

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

CreateHsmRequest returns a request value for making 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.

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

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

func (*Client) CreateLunaClientRequest added in v0.23.2

func (c *Client) CreateLunaClientRequest(input *CreateLunaClientInput) CreateLunaClientRequest

CreateLunaClientRequest returns a request value for making 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.

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

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

func (*Client) DeleteHapgRequest added in v0.23.2

func (c *Client) DeleteHapgRequest(input *DeleteHapgInput) DeleteHapgRequest

DeleteHapgRequest returns a request value for making 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.

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

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

func (*Client) DeleteHsmRequest added in v0.23.2

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

DeleteHsmRequest returns a request value for making 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.

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

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

func (*Client) DeleteLunaClientRequest added in v0.23.2

func (c *Client) DeleteLunaClientRequest(input *DeleteLunaClientInput) DeleteLunaClientRequest

DeleteLunaClientRequest returns a request value for making 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.

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

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

func (*Client) DescribeHapgRequest added in v0.23.2

func (c *Client) DescribeHapgRequest(input *DescribeHapgInput) DescribeHapgRequest

DescribeHapgRequest returns a request value for making 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.

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

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

func (*Client) DescribeHsmRequest added in v0.23.2

func (c *Client) DescribeHsmRequest(input *DescribeHsmInput) DescribeHsmRequest

DescribeHsmRequest returns a request value for making 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.

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

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

func (*Client) DescribeLunaClientRequest added in v0.23.2

func (c *Client) DescribeLunaClientRequest(input *DescribeLunaClientInput) DescribeLunaClientRequest

DescribeLunaClientRequest returns a request value for making 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.

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

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

func (*Client) GetConfigRequest added in v0.23.2

func (c *Client) GetConfigRequest(input *GetConfigInput) GetConfigRequest

GetConfigRequest returns a request value for making 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.

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

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

func (*Client) ListAvailableZonesRequest added in v0.23.2

func (c *Client) ListAvailableZonesRequest(input *ListAvailableZonesInput) ListAvailableZonesRequest

ListAvailableZonesRequest returns a request value for making 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.

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

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

func (*Client) ListHapgsRequest added in v0.23.2

func (c *Client) ListHapgsRequest(input *ListHapgsInput) ListHapgsRequest

ListHapgsRequest returns a request value for making 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.

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

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

func (*Client) ListHsmsRequest added in v0.23.2

func (c *Client) ListHsmsRequest(input *ListHsmsInput) ListHsmsRequest

ListHsmsRequest returns a request value for making 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.

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

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

func (*Client) ListLunaClientsRequest added in v0.23.2

func (c *Client) ListLunaClientsRequest(input *ListLunaClientsInput) ListLunaClientsRequest

ListLunaClientsRequest returns a request value for making 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.

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

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

func (*Client) ListTagsForResourceRequest added in v0.23.2

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making 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.

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

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

func (*Client) ModifyHapgRequest added in v0.23.2

func (c *Client) ModifyHapgRequest(input *ModifyHapgInput) ModifyHapgRequest

ModifyHapgRequest returns a request value for making 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.

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

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

func (*Client) ModifyHsmRequest added in v0.23.2

func (c *Client) ModifyHsmRequest(input *ModifyHsmInput) ModifyHsmRequest

ModifyHsmRequest returns a request value for making 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.

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

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

func (*Client) ModifyLunaClientRequest added in v0.23.2

func (c *Client) ModifyLunaClientRequest(input *ModifyLunaClientInput) ModifyLunaClientRequest

ModifyLunaClientRequest returns a request value for making 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.

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

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

func (*Client) RemoveTagsFromResourceRequest added in v0.23.2

func (c *Client) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) RemoveTagsFromResourceRequest

RemoveTagsFromResourceRequest returns a request value for making 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.

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

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

type CloudHsmObjectState

type CloudHsmObjectState string
const (
	CloudHsmObjectStateReady    CloudHsmObjectState = "READY"
	CloudHsmObjectStateUpdating CloudHsmObjectState = "UPDATING"
	CloudHsmObjectStateDegraded CloudHsmObjectState = "DEGRADED"
)

Enum values for CloudHsmObjectState

func (CloudHsmObjectState) MarshalValue added in v0.3.0

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

func (CloudHsmObjectState) MarshalValueBuf added in v0.3.0

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

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

func (s CreateHapgOutput) String() string

String returns the string representation

type CreateHapgRequest

type CreateHapgRequest struct {
	*aws.Request
	Input *CreateHapgInput
	Copy  func(*CreateHapgInput) CreateHapgRequest
}

CreateHapgRequest is the request type for the CreateHapg API operation.

func (CreateHapgRequest) Send

Send marshals and sends the CreateHapg API request.

type CreateHapgResponse added in v0.23.2

type CreateHapgResponse struct {
	*CreateHapgOutput
	// contains filtered or unexported fields
}

CreateHapgResponse is the response type for the CreateHapg API operation.

func (*CreateHapgResponse) SDKResponseMetdata added in v0.23.2

func (r *CreateHapgResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateHapg request.

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 SubscriptionType `locationName:"SubscriptionType" type:"string" required:"true" enum:"true"`

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

func (s CreateHsmOutput) String() string

String returns the string representation

type CreateHsmRequest

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

CreateHsmRequest is the request type for the CreateHsm API operation.

func (CreateHsmRequest) Send

Send marshals and sends the CreateHsm API request.

type CreateHsmResponse added in v0.23.2

type CreateHsmResponse struct {
	*CreateHsmOutput
	// contains filtered or unexported fields
}

CreateHsmResponse is the response type for the CreateHsm API operation.

func (*CreateHsmResponse) SDKResponseMetdata added in v0.23.2

func (r *CreateHsmResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateHsm request.

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

func (s CreateLunaClientOutput) String() string

String returns the string representation

type CreateLunaClientRequest

type CreateLunaClientRequest struct {
	*aws.Request
	Input *CreateLunaClientInput
	Copy  func(*CreateLunaClientInput) CreateLunaClientRequest
}

CreateLunaClientRequest is the request type for the CreateLunaClient API operation.

func (CreateLunaClientRequest) Send

Send marshals and sends the CreateLunaClient API request.

type CreateLunaClientResponse added in v0.23.2

type CreateLunaClientResponse struct {
	*CreateLunaClientOutput
	// contains filtered or unexported fields
}

CreateLunaClientResponse is the response type for the CreateLunaClient API operation.

func (*CreateLunaClientResponse) SDKResponseMetdata added in v0.23.2

func (r *CreateLunaClientResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateLunaClient request.

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

func (s DeleteHapgOutput) String() string

String returns the string representation

type DeleteHapgRequest

type DeleteHapgRequest struct {
	*aws.Request
	Input *DeleteHapgInput
	Copy  func(*DeleteHapgInput) DeleteHapgRequest
}

DeleteHapgRequest is the request type for the DeleteHapg API operation.

func (DeleteHapgRequest) Send

Send marshals and sends the DeleteHapg API request.

type DeleteHapgResponse added in v0.23.2

type DeleteHapgResponse struct {
	*DeleteHapgOutput
	// contains filtered or unexported fields
}

DeleteHapgResponse is the response type for the DeleteHapg API operation.

func (*DeleteHapgResponse) SDKResponseMetdata added in v0.23.2

func (r *DeleteHapgResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteHapg request.

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

func (s DeleteHsmOutput) String() string

String returns the string representation

type DeleteHsmRequest

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

DeleteHsmRequest is the request type for the DeleteHsm API operation.

func (DeleteHsmRequest) Send

Send marshals and sends the DeleteHsm API request.

type DeleteHsmResponse added in v0.23.2

type DeleteHsmResponse struct {
	*DeleteHsmOutput
	// contains filtered or unexported fields
}

DeleteHsmResponse is the response type for the DeleteHsm API operation.

func (*DeleteHsmResponse) SDKResponseMetdata added in v0.23.2

func (r *DeleteHsmResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteHsm request.

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

func (s DeleteLunaClientOutput) String() string

String returns the string representation

type DeleteLunaClientRequest

type DeleteLunaClientRequest struct {
	*aws.Request
	Input *DeleteLunaClientInput
	Copy  func(*DeleteLunaClientInput) DeleteLunaClientRequest
}

DeleteLunaClientRequest is the request type for the DeleteLunaClient API operation.

func (DeleteLunaClientRequest) Send

Send marshals and sends the DeleteLunaClient API request.

type DeleteLunaClientResponse added in v0.23.2

type DeleteLunaClientResponse struct {
	*DeleteLunaClientOutput
	// contains filtered or unexported fields
}

DeleteLunaClientResponse is the response type for the DeleteLunaClient API operation.

func (*DeleteLunaClientResponse) SDKResponseMetdata added in v0.23.2

func (r *DeleteLunaClientResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteLunaClient request.

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) 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 CloudHsmObjectState `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Contains the output of the DescribeHapg action.

func (DescribeHapgOutput) String

func (s DescribeHapgOutput) String() string

String returns the string representation

type DescribeHapgRequest

type DescribeHapgRequest struct {
	*aws.Request
	Input *DescribeHapgInput
	Copy  func(*DescribeHapgInput) DescribeHapgRequest
}

DescribeHapgRequest is the request type for the DescribeHapg API operation.

func (DescribeHapgRequest) Send

Send marshals and sends the DescribeHapg API request.

type DescribeHapgResponse added in v0.23.2

type DescribeHapgResponse struct {
	*DescribeHapgOutput
	// contains filtered or unexported fields
}

DescribeHapgResponse is the response type for the DescribeHapg API operation.

func (*DescribeHapgResponse) SDKResponseMetdata added in v0.23.2

func (r *DescribeHapgResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeHapg request.

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) 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 HsmStatus `type:"string" enum:"true"`

	// 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 SubscriptionType `type:"string" enum:"true"`

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

func (s DescribeHsmOutput) String() string

String returns the string representation

type DescribeHsmRequest

type DescribeHsmRequest struct {
	*aws.Request
	Input *DescribeHsmInput
	Copy  func(*DescribeHsmInput) DescribeHsmRequest
}

DescribeHsmRequest is the request type for the DescribeHsm API operation.

func (DescribeHsmRequest) Send

Send marshals and sends the DescribeHsm API request.

type DescribeHsmResponse added in v0.23.2

type DescribeHsmResponse struct {
	*DescribeHsmOutput
	// contains filtered or unexported fields
}

DescribeHsmResponse is the response type for the DescribeHsm API operation.

func (*DescribeHsmResponse) SDKResponseMetdata added in v0.23.2

func (r *DescribeHsmResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeHsm request.

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

func (s DescribeLunaClientOutput) String() string

String returns the string representation

type DescribeLunaClientRequest

type DescribeLunaClientRequest struct {
	*aws.Request
	Input *DescribeLunaClientInput
	Copy  func(*DescribeLunaClientInput) DescribeLunaClientRequest
}

DescribeLunaClientRequest is the request type for the DescribeLunaClient API operation.

func (DescribeLunaClientRequest) Send

Send marshals and sends the DescribeLunaClient API request.

type DescribeLunaClientResponse added in v0.23.2

type DescribeLunaClientResponse struct {
	*DescribeLunaClientOutput
	// contains filtered or unexported fields
}

DescribeLunaClientResponse is the response type for the DescribeLunaClient API operation.

func (*DescribeLunaClientResponse) SDKResponseMetdata added in v0.23.2

func (r *DescribeLunaClientResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLunaClient request.

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 Version `type:"string" required:"true" enum:"true"`

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

func (s GetConfigOutput) String() string

String returns the string representation

type GetConfigRequest

type GetConfigRequest struct {
	*aws.Request
	Input *GetConfigInput
	Copy  func(*GetConfigInput) GetConfigRequest
}

GetConfigRequest is the request type for the GetConfig API operation.

func (GetConfigRequest) Send

Send marshals and sends the GetConfig API request.

type GetConfigResponse added in v0.23.2

type GetConfigResponse struct {
	*GetConfigOutput
	// contains filtered or unexported fields
}

GetConfigResponse is the response type for the GetConfig API operation.

func (*GetConfigResponse) SDKResponseMetdata added in v0.23.2

func (r *GetConfigResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the GetConfig request.

type HsmStatus

type HsmStatus string
const (
	HsmStatusPending     HsmStatus = "PENDING"
	HsmStatusRunning     HsmStatus = "RUNNING"
	HsmStatusUpdating    HsmStatus = "UPDATING"
	HsmStatusSuspended   HsmStatus = "SUSPENDED"
	HsmStatusTerminating HsmStatus = "TERMINATING"
	HsmStatusTerminated  HsmStatus = "TERMINATED"
	HsmStatusDegraded    HsmStatus = "DEGRADED"
)

Enum values for HsmStatus

func (HsmStatus) MarshalValue added in v0.3.0

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

func (HsmStatus) MarshalValueBuf added in v0.3.0

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

type ListAvailableZonesInput

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

Contains the inputs for the ListAvailableZones action.

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

func (s ListAvailableZonesOutput) String() string

String returns the string representation

type ListAvailableZonesRequest

type ListAvailableZonesRequest struct {
	*aws.Request
	Input *ListAvailableZonesInput
	Copy  func(*ListAvailableZonesInput) ListAvailableZonesRequest
}

ListAvailableZonesRequest is the request type for the ListAvailableZones API operation.

func (ListAvailableZonesRequest) Send

Send marshals and sends the ListAvailableZones API request.

type ListAvailableZonesResponse added in v0.23.2

type ListAvailableZonesResponse struct {
	*ListAvailableZonesOutput
	// contains filtered or unexported fields
}

ListAvailableZonesResponse is the response type for the ListAvailableZones API operation.

func (*ListAvailableZonesResponse) SDKResponseMetdata added in v0.23.2

func (r *ListAvailableZonesResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAvailableZones request.

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

func (s ListHapgsOutput) String() string

String returns the string representation

type ListHapgsRequest

type ListHapgsRequest struct {
	*aws.Request
	Input *ListHapgsInput
	Copy  func(*ListHapgsInput) ListHapgsRequest
}

ListHapgsRequest is the request type for the ListHapgs API operation.

func (ListHapgsRequest) Send

Send marshals and sends the ListHapgs API request.

type ListHapgsResponse added in v0.23.2

type ListHapgsResponse struct {
	*ListHapgsOutput
	// contains filtered or unexported fields
}

ListHapgsResponse is the response type for the ListHapgs API operation.

func (*ListHapgsResponse) SDKResponseMetdata added in v0.23.2

func (r *ListHapgsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListHapgs request.

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

func (s ListHsmsOutput) String() string

String returns the string representation

type ListHsmsRequest

type ListHsmsRequest struct {
	*aws.Request
	Input *ListHsmsInput
	Copy  func(*ListHsmsInput) ListHsmsRequest
}

ListHsmsRequest is the request type for the ListHsms API operation.

func (ListHsmsRequest) Send

Send marshals and sends the ListHsms API request.

type ListHsmsResponse added in v0.23.2

type ListHsmsResponse struct {
	*ListHsmsOutput
	// contains filtered or unexported fields
}

ListHsmsResponse is the response type for the ListHsms API operation.

func (*ListHsmsResponse) SDKResponseMetdata added in v0.23.2

func (r *ListHsmsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListHsms request.

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

func (s ListLunaClientsOutput) String() string

String returns the string representation

type ListLunaClientsRequest

type ListLunaClientsRequest struct {
	*aws.Request
	Input *ListLunaClientsInput
	Copy  func(*ListLunaClientsInput) ListLunaClientsRequest
}

ListLunaClientsRequest is the request type for the ListLunaClients API operation.

func (ListLunaClientsRequest) Send

Send marshals and sends the ListLunaClients API request.

type ListLunaClientsResponse added in v0.23.2

type ListLunaClientsResponse struct {
	*ListLunaClientsOutput
	// contains filtered or unexported fields
}

ListLunaClientsResponse is the response type for the ListLunaClients API operation.

func (*ListLunaClientsResponse) SDKResponseMetdata added in v0.23.2

func (r *ListLunaClientsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListLunaClients request.

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

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourceRequest

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.23.2

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.23.2

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

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

func (s ModifyHapgOutput) String() string

String returns the string representation

type ModifyHapgRequest

type ModifyHapgRequest struct {
	*aws.Request
	Input *ModifyHapgInput
	Copy  func(*ModifyHapgInput) ModifyHapgRequest
}

ModifyHapgRequest is the request type for the ModifyHapg API operation.

func (ModifyHapgRequest) Send

Send marshals and sends the ModifyHapg API request.

type ModifyHapgResponse added in v0.23.2

type ModifyHapgResponse struct {
	*ModifyHapgOutput
	// contains filtered or unexported fields
}

ModifyHapgResponse is the response type for the ModifyHapg API operation.

func (*ModifyHapgResponse) SDKResponseMetdata added in v0.23.2

func (r *ModifyHapgResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyHapg request.

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

func (s ModifyHsmOutput) String() string

String returns the string representation

type ModifyHsmRequest

type ModifyHsmRequest struct {
	*aws.Request
	Input *ModifyHsmInput
	Copy  func(*ModifyHsmInput) ModifyHsmRequest
}

ModifyHsmRequest is the request type for the ModifyHsm API operation.

func (ModifyHsmRequest) Send

Send marshals and sends the ModifyHsm API request.

type ModifyHsmResponse added in v0.23.2

type ModifyHsmResponse struct {
	*ModifyHsmOutput
	// contains filtered or unexported fields
}

ModifyHsmResponse is the response type for the ModifyHsm API operation.

func (*ModifyHsmResponse) SDKResponseMetdata added in v0.23.2

func (r *ModifyHsmResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyHsm request.

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

func (s ModifyLunaClientOutput) String() string

String returns the string representation

type ModifyLunaClientRequest

type ModifyLunaClientRequest struct {
	*aws.Request
	Input *ModifyLunaClientInput
	Copy  func(*ModifyLunaClientInput) ModifyLunaClientRequest
}

ModifyLunaClientRequest is the request type for the ModifyLunaClient API operation.

func (ModifyLunaClientRequest) Send

Send marshals and sends the ModifyLunaClient API request.

type ModifyLunaClientResponse added in v0.23.2

type ModifyLunaClientResponse struct {
	*ModifyLunaClientOutput
	// contains filtered or unexported fields
}

ModifyLunaClientResponse is the response type for the ModifyLunaClient API operation.

func (*ModifyLunaClientResponse) SDKResponseMetdata added in v0.23.2

func (r *ModifyLunaClientResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ModifyLunaClient request.

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

String returns the string representation

type RemoveTagsFromResourceRequest

type RemoveTagsFromResourceRequest struct {
	*aws.Request
	Input *RemoveTagsFromResourceInput
	Copy  func(*RemoveTagsFromResourceInput) RemoveTagsFromResourceRequest
}

RemoveTagsFromResourceRequest is the request type for the RemoveTagsFromResource API operation.

func (RemoveTagsFromResourceRequest) Send

Send marshals and sends the RemoveTagsFromResource API request.

type RemoveTagsFromResourceResponse added in v0.23.2

type RemoveTagsFromResourceResponse struct {
	*RemoveTagsFromResourceOutput
	// contains filtered or unexported fields
}

RemoveTagsFromResourceResponse is the response type for the RemoveTagsFromResource API operation.

func (*RemoveTagsFromResourceResponse) SDKResponseMetdata added in v0.23.2

func (r *RemoveTagsFromResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RemoveTagsFromResource request.

type SubscriptionType

type SubscriptionType 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.

const (
	SubscriptionTypeProduction SubscriptionType = "PRODUCTION"
)

Enum values for SubscriptionType

func (SubscriptionType) MarshalValue added in v0.3.0

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

func (SubscriptionType) MarshalValueBuf added in v0.3.0

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

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

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

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

type Version added in v0.23.2

type Version string
const (
	Version51 Version = "5.1"
	Version53 Version = "5.3"
)

Enum values for Version

func (Version) MarshalValue added in v0.23.2

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

func (Version) MarshalValueBuf added in v0.23.2

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

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