Documentation

Overview

    Package cloudhsm provides the API client, operations, and parameter types for Amazon CloudHSM.

    AWS CloudHSM Service 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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/).

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2014-05-30"
    View Source
    const ServiceID = "CloudHSM"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type AddTagsToResourceInput

          type AddTagsToResourceInput struct {
          
          	// The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag.
          	//
          	// This member is required.
          	ResourceArn *string
          
          	// One or more tags.
          	//
          	// This member is required.
          	TagList []types.Tag
          }

          type AddTagsToResourceOutput

          type AddTagsToResourceOutput struct {
          
          	// The status of the operation.
          	//
          	// This member is required.
          	Status *string
          
          	// Metadata pertaining to the operation's result.
          	ResultMetadata middleware.Metadata
          }

          type Client

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

            Client provides the API client to make operations call for Amazon CloudHSM.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) AddTagsToResource

                func (c *Client) AddTagsToResource(ctx context.Context, params *AddTagsToResourceInput, optFns ...func(*Options)) (*AddTagsToResourceOutput, error)

                  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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                  func (*Client) CreateHapg

                  func (c *Client) CreateHapg(ctx context.Context, params *CreateHapgInput, optFns ...func(*Options)) (*CreateHapgOutput, error)

                    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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                    func (*Client) CreateHsm

                    func (c *Client) CreateHsm(ctx context.Context, params *CreateHsmInput, optFns ...func(*Options)) (*CreateHsmOutput, error)

                      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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                      func (*Client) CreateLunaClient

                      func (c *Client) CreateLunaClient(ctx context.Context, params *CreateLunaClientInput, optFns ...func(*Options)) (*CreateLunaClientOutput, error)

                        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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Creates an HSM client.

                        func (*Client) DeleteHapg

                        func (c *Client) DeleteHapg(ctx context.Context, params *DeleteHapgInput, optFns ...func(*Options)) (*DeleteHapgOutput, error)

                          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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Deletes a high-availability partition group.

                          func (*Client) DeleteHsm

                          func (c *Client) DeleteHsm(ctx context.Context, params *DeleteHsmInput, optFns ...func(*Options)) (*DeleteHsmOutput, error)

                            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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.

                            func (*Client) DeleteLunaClient

                            func (c *Client) DeleteLunaClient(ctx context.Context, params *DeleteLunaClientInput, optFns ...func(*Options)) (*DeleteLunaClientOutput, error)

                              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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Deletes a client.

                              func (*Client) DescribeHapg

                              func (c *Client) DescribeHapg(ctx context.Context, params *DescribeHapgInput, optFns ...func(*Options)) (*DescribeHapgOutput, error)

                                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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Retrieves information about a high-availability partition group.

                                func (*Client) DescribeHsm

                                func (c *Client) DescribeHsm(ctx context.Context, params *DescribeHsmInput, optFns ...func(*Options)) (*DescribeHsmOutput, error)

                                  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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.

                                  func (*Client) DescribeLunaClient

                                  func (c *Client) DescribeLunaClient(ctx context.Context, params *DescribeLunaClientInput, optFns ...func(*Options)) (*DescribeLunaClientOutput, error)

                                    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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Retrieves information about an HSM client.

                                    func (*Client) GetConfig

                                    func (c *Client) GetConfig(ctx context.Context, params *GetConfigInput, optFns ...func(*Options)) (*GetConfigOutput, error)

                                      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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                                      func (*Client) ListAvailableZones

                                      func (c *Client) ListAvailableZones(ctx context.Context, params *ListAvailableZonesInput, optFns ...func(*Options)) (*ListAvailableZonesOutput, error)

                                        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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Lists the Availability Zones that have available AWS CloudHSM capacity.

                                        func (*Client) ListHapgs

                                        func (c *Client) ListHapgs(ctx context.Context, params *ListHapgsInput, optFns ...func(*Options)) (*ListHapgsOutput, error)

                                          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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                                          func (*Client) ListHsms

                                          func (c *Client) ListHsms(ctx context.Context, params *ListHsmsInput, optFns ...func(*Options)) (*ListHsmsOutput, error)

                                            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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                                            func (*Client) ListLunaClients

                                            func (c *Client) ListLunaClients(ctx context.Context, params *ListLunaClientsInput, optFns ...func(*Options)) (*ListLunaClientsOutput, error)

                                              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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                                              func (*Client) ListTagsForResource

                                              func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

                                                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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Returns a list of all tags for the specified AWS CloudHSM resource.

                                                func (*Client) ModifyHapg

                                                func (c *Client) ModifyHapg(ctx context.Context, params *ModifyHapgInput, optFns ...func(*Options)) (*ModifyHapgOutput, error)

                                                  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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://docs.aws.amazon.com/cloudhsm/latest/APIReference/). Modifies an existing high-availability partition group.

                                                  func (*Client) ModifyHsm

                                                  func (c *Client) ModifyHsm(ctx context.Context, params *ModifyHsmInput, optFns ...func(*Options)) (*ModifyHsmOutput, error)

                                                    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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                                                    func (*Client) ModifyLunaClient

                                                    func (c *Client) ModifyLunaClient(ctx context.Context, params *ModifyLunaClientInput, optFns ...func(*Options)) (*ModifyLunaClientOutput, error)

                                                      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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                                                      func (*Client) RemoveTagsFromResource

                                                      func (c *Client) RemoveTagsFromResource(ctx context.Context, params *RemoveTagsFromResourceInput, optFns ...func(*Options)) (*RemoveTagsFromResourceOutput, error)

                                                        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 (https://docs.aws.amazon.com/cloudhsm/classic/userguide/), and the AWS CloudHSM Classic API Reference (https://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 (https://docs.aws.amazon.com/cloudhsm/latest/userguide/), and the AWS CloudHSM API Reference (https://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.

                                                        type CreateHapgInput

                                                        type CreateHapgInput struct {
                                                        
                                                        	// The label of the new high-availability partition group.
                                                        	//
                                                        	// This member is required.
                                                        	Label *string
                                                        }

                                                          Contains the inputs for the CreateHapgRequest action.

                                                          type CreateHapgOutput

                                                          type CreateHapgOutput struct {
                                                          
                                                          	// The ARN of the high-availability partition group.
                                                          	HapgArn *string
                                                          
                                                          	// Metadata pertaining to the operation's result.
                                                          	ResultMetadata middleware.Metadata
                                                          }

                                                            Contains the output of the CreateHAPartitionGroup action.

                                                            type CreateHsmInput

                                                            type CreateHsmInput struct {
                                                            
                                                            	// The ARN of an IAM role to enable the AWS CloudHSM service to allocate an ENI on
                                                            	// your behalf.
                                                            	//
                                                            	// This member is required.
                                                            	IamRoleArn *string
                                                            
                                                            	// The SSH public key to install on the HSM.
                                                            	//
                                                            	// This member is required.
                                                            	SshKey *string
                                                            
                                                            	// The identifier of the subnet in your VPC in which to place the HSM.
                                                            	//
                                                            	// This member is required.
                                                            	SubnetId *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.
                                                            	//
                                                            	// This member is required.
                                                            	SubscriptionType types.SubscriptionType
                                                            
                                                            	// A user-defined token to ensure idempotence. Subsequent calls to this operation
                                                            	// with the same token will be ignored.
                                                            	ClientToken *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
                                                            
                                                            	// The external ID from IamRoleArn, if present.
                                                            	ExternalId *string
                                                            
                                                            	// The IP address for the syslog monitoring server. The AWS CloudHSM service only
                                                            	// supports one syslog monitoring server.
                                                            	SyslogIp *string
                                                            }

                                                              Contains the inputs for the CreateHsm operation.

                                                              type CreateHsmOutput

                                                              type CreateHsmOutput struct {
                                                              
                                                              	// The ARN of the HSM.
                                                              	HsmArn *string
                                                              
                                                              	// Metadata pertaining to the operation's result.
                                                              	ResultMetadata middleware.Metadata
                                                              }

                                                                Contains the output of the CreateHsm operation.

                                                                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.
                                                                	//
                                                                	// This member is required.
                                                                	Certificate *string
                                                                
                                                                	// The label for the client.
                                                                	Label *string
                                                                }

                                                                  Contains the inputs for the CreateLunaClient action.

                                                                  type CreateLunaClientOutput

                                                                  type CreateLunaClientOutput struct {
                                                                  
                                                                  	// The ARN of the client.
                                                                  	ClientArn *string
                                                                  
                                                                  	// Metadata pertaining to the operation's result.
                                                                  	ResultMetadata middleware.Metadata
                                                                  }

                                                                    Contains the output of the CreateLunaClient action.

                                                                    type DeleteHapgInput

                                                                    type DeleteHapgInput struct {
                                                                    
                                                                    	// The ARN of the high-availability partition group to delete.
                                                                    	//
                                                                    	// This member is required.
                                                                    	HapgArn *string
                                                                    }

                                                                      Contains the inputs for the DeleteHapg action.

                                                                      type DeleteHapgOutput

                                                                      type DeleteHapgOutput struct {
                                                                      
                                                                      	// The status of the action.
                                                                      	//
                                                                      	// This member is required.
                                                                      	Status *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                        Contains the output of the DeleteHapg action.

                                                                        type DeleteHsmInput

                                                                        type DeleteHsmInput struct {
                                                                        
                                                                        	// The ARN of the HSM to delete.
                                                                        	//
                                                                        	// This member is required.
                                                                        	HsmArn *string
                                                                        }

                                                                          Contains the inputs for the DeleteHsm operation.

                                                                          type DeleteHsmOutput

                                                                          type DeleteHsmOutput struct {
                                                                          
                                                                          	// The status of the operation.
                                                                          	//
                                                                          	// This member is required.
                                                                          	Status *string
                                                                          
                                                                          	// Metadata pertaining to the operation's result.
                                                                          	ResultMetadata middleware.Metadata
                                                                          }

                                                                            Contains the output of the DeleteHsm operation.

                                                                            type DeleteLunaClientInput

                                                                            type DeleteLunaClientInput struct {
                                                                            
                                                                            	// The ARN of the client to delete.
                                                                            	//
                                                                            	// This member is required.
                                                                            	ClientArn *string
                                                                            }

                                                                            type DeleteLunaClientOutput

                                                                            type DeleteLunaClientOutput struct {
                                                                            
                                                                            	// The status of the action.
                                                                            	//
                                                                            	// This member is required.
                                                                            	Status *string
                                                                            
                                                                            	// Metadata pertaining to the operation's result.
                                                                            	ResultMetadata middleware.Metadata
                                                                            }

                                                                            type DescribeHapgInput

                                                                            type DescribeHapgInput struct {
                                                                            
                                                                            	// The ARN of the high-availability partition group to describe.
                                                                            	//
                                                                            	// This member is required.
                                                                            	HapgArn *string
                                                                            }

                                                                              Contains the inputs for the DescribeHapg action.

                                                                              type DescribeHapgOutput

                                                                              type DescribeHapgOutput struct {
                                                                              
                                                                              	// The ARN of the high-availability partition group.
                                                                              	HapgArn *string
                                                                              
                                                                              	// The serial number of the high-availability partition group.
                                                                              	HapgSerial *string
                                                                              
                                                                              	//
                                                                              	HsmsLastActionFailed []string
                                                                              
                                                                              	//
                                                                              	HsmsPendingDeletion []string
                                                                              
                                                                              	//
                                                                              	HsmsPendingRegistration []string
                                                                              
                                                                              	// The label for the high-availability partition group.
                                                                              	Label *string
                                                                              
                                                                              	// The date and time the high-availability partition group was last modified.
                                                                              	LastModifiedTimestamp *string
                                                                              
                                                                              	// The list of partition serial numbers that belong to the high-availability
                                                                              	// partition group.
                                                                              	PartitionSerialList []string
                                                                              
                                                                              	// The state of the high-availability partition group.
                                                                              	State types.CloudHsmObjectState
                                                                              
                                                                              	// Metadata pertaining to the operation's result.
                                                                              	ResultMetadata middleware.Metadata
                                                                              }

                                                                                Contains the output of the DescribeHapg action.

                                                                                type DescribeHsmInput

                                                                                type DescribeHsmInput struct {
                                                                                
                                                                                	// The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must be
                                                                                	// specified.
                                                                                	HsmArn *string
                                                                                
                                                                                	// The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter
                                                                                	// must be specified.
                                                                                	HsmSerialNumber *string
                                                                                }

                                                                                  Contains the inputs for the DescribeHsm operation.

                                                                                  type DescribeHsmOutput

                                                                                  type DescribeHsmOutput struct {
                                                                                  
                                                                                  	// The Availability Zone that the HSM is in.
                                                                                  	AvailabilityZone *string
                                                                                  
                                                                                  	// The identifier of the elastic network interface (ENI) attached to the HSM.
                                                                                  	EniId *string
                                                                                  
                                                                                  	// The IP address assigned to the HSM's ENI.
                                                                                  	EniIp *string
                                                                                  
                                                                                  	// The ARN of the HSM.
                                                                                  	HsmArn *string
                                                                                  
                                                                                  	// The HSM model type.
                                                                                  	HsmType *string
                                                                                  
                                                                                  	// The ARN of the IAM role assigned to the HSM.
                                                                                  	IamRoleArn *string
                                                                                  
                                                                                  	// The list of partitions on the HSM.
                                                                                  	Partitions []string
                                                                                  
                                                                                  	// The serial number of the HSM.
                                                                                  	SerialNumber *string
                                                                                  
                                                                                  	// The date and time that the server certificate was last updated.
                                                                                  	ServerCertLastUpdated *string
                                                                                  
                                                                                  	// The URI of the certificate server.
                                                                                  	ServerCertUri *string
                                                                                  
                                                                                  	// The HSM software version.
                                                                                  	SoftwareVersion *string
                                                                                  
                                                                                  	// The date and time that the SSH key was last updated.
                                                                                  	SshKeyLastUpdated *string
                                                                                  
                                                                                  	// The public SSH key.
                                                                                  	SshPublicKey *string
                                                                                  
                                                                                  	// The status of the HSM.
                                                                                  	Status types.HsmStatus
                                                                                  
                                                                                  	// Contains additional information about the status of the HSM.
                                                                                  	StatusDetails *string
                                                                                  
                                                                                  	// The identifier of the subnet that the HSM is in.
                                                                                  	SubnetId *string
                                                                                  
                                                                                  	// The subscription end date.
                                                                                  	SubscriptionEndDate *string
                                                                                  
                                                                                  	// The subscription start date.
                                                                                  	SubscriptionStartDate *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 types.SubscriptionType
                                                                                  
                                                                                  	// The name of the HSM vendor.
                                                                                  	VendorName *string
                                                                                  
                                                                                  	// The identifier of the VPC that the HSM is in.
                                                                                  	VpcId *string
                                                                                  
                                                                                  	// Metadata pertaining to the operation's result.
                                                                                  	ResultMetadata middleware.Metadata
                                                                                  }

                                                                                    Contains the output of the DescribeHsm operation.

                                                                                    type DescribeLunaClientInput

                                                                                    type DescribeLunaClientInput struct {
                                                                                    
                                                                                    	// The certificate fingerprint.
                                                                                    	CertificateFingerprint *string
                                                                                    
                                                                                    	// The ARN of the client.
                                                                                    	ClientArn *string
                                                                                    }

                                                                                    type DescribeLunaClientOutput

                                                                                    type DescribeLunaClientOutput struct {
                                                                                    
                                                                                    	// The certificate installed on the HSMs used by this client.
                                                                                    	Certificate *string
                                                                                    
                                                                                    	// The certificate fingerprint.
                                                                                    	CertificateFingerprint *string
                                                                                    
                                                                                    	// The ARN of the client.
                                                                                    	ClientArn *string
                                                                                    
                                                                                    	// The label of the client.
                                                                                    	Label *string
                                                                                    
                                                                                    	// The date and time the client was last modified.
                                                                                    	LastModifiedTimestamp *string
                                                                                    
                                                                                    	// Metadata pertaining to the operation's result.
                                                                                    	ResultMetadata middleware.Metadata
                                                                                    }

                                                                                    type EndpointResolver

                                                                                    type EndpointResolver interface {
                                                                                    	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                                                                    }

                                                                                      EndpointResolver interface for resolving service endpoints.

                                                                                      func EndpointResolverFromURL

                                                                                      func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                                                                        EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                                                                        type EndpointResolverFunc

                                                                                        type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                                                                          EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                                                                          func (EndpointResolverFunc) ResolveEndpoint

                                                                                          func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                                                                          type EndpointResolverOptions

                                                                                          type EndpointResolverOptions = internalendpoints.Options

                                                                                            EndpointResolverOptions is the service endpoint resolver options

                                                                                            type GetConfigInput

                                                                                            type GetConfigInput struct {
                                                                                            
                                                                                            	// The ARN of the client.
                                                                                            	//
                                                                                            	// This member is required.
                                                                                            	ClientArn *string
                                                                                            
                                                                                            	// The client version.
                                                                                            	//
                                                                                            	// This member is required.
                                                                                            	ClientVersion types.ClientVersion
                                                                                            
                                                                                            	// A list of ARNs that identify the high-availability partition groups that are
                                                                                            	// associated with the client.
                                                                                            	//
                                                                                            	// This member is required.
                                                                                            	HapgList []string
                                                                                            }

                                                                                            type GetConfigOutput

                                                                                            type GetConfigOutput struct {
                                                                                            
                                                                                            	// The certificate file containing the server.pem files of the HSMs.
                                                                                            	ConfigCred *string
                                                                                            
                                                                                            	// The chrystoki.conf configuration file.
                                                                                            	ConfigFile *string
                                                                                            
                                                                                            	// The type of credentials.
                                                                                            	ConfigType *string
                                                                                            
                                                                                            	// Metadata pertaining to the operation's result.
                                                                                            	ResultMetadata middleware.Metadata
                                                                                            }

                                                                                            type HTTPClient

                                                                                            type HTTPClient interface {
                                                                                            	Do(*http.Request) (*http.Response, error)
                                                                                            }

                                                                                            type HTTPSignerV4

                                                                                            type HTTPSignerV4 interface {
                                                                                            	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                                                            }

                                                                                            type ListAvailableZonesInput

                                                                                            type ListAvailableZonesInput struct {
                                                                                            }

                                                                                              Contains the inputs for the ListAvailableZones action.

                                                                                              type ListAvailableZonesOutput

                                                                                              type ListAvailableZonesOutput struct {
                                                                                              
                                                                                              	// The list of Availability Zones that have available AWS CloudHSM capacity.
                                                                                              	AZList []string
                                                                                              
                                                                                              	// Metadata pertaining to the operation's result.
                                                                                              	ResultMetadata middleware.Metadata
                                                                                              }

                                                                                              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 ListHapgsOutput

                                                                                              type ListHapgsOutput struct {
                                                                                              
                                                                                              	// The list of high-availability partition groups.
                                                                                              	//
                                                                                              	// This member is required.
                                                                                              	HapgList []string
                                                                                              
                                                                                              	// If not null, more results are available. Pass this value to ListHapgs to
                                                                                              	// retrieve the next set of items.
                                                                                              	NextToken *string
                                                                                              
                                                                                              	// Metadata pertaining to the operation's result.
                                                                                              	ResultMetadata middleware.Metadata
                                                                                              }

                                                                                              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 ListHsmsOutput

                                                                                              type ListHsmsOutput struct {
                                                                                              
                                                                                              	// The list of ARNs that identify the HSMs.
                                                                                              	HsmList []string
                                                                                              
                                                                                              	// If not null, more results are available. Pass this value to ListHsms to retrieve
                                                                                              	// the next set of items.
                                                                                              	NextToken *string
                                                                                              
                                                                                              	// Metadata pertaining to the operation's result.
                                                                                              	ResultMetadata middleware.Metadata
                                                                                              }

                                                                                                Contains the output of the ListHsms operation.

                                                                                                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 ListLunaClientsOutput

                                                                                                type ListLunaClientsOutput struct {
                                                                                                
                                                                                                	// The list of clients.
                                                                                                	//
                                                                                                	// This member is required.
                                                                                                	ClientList []string
                                                                                                
                                                                                                	// If not null, more results are available. Pass this to ListLunaClients to
                                                                                                	// retrieve the next set of items.
                                                                                                	NextToken *string
                                                                                                
                                                                                                	// Metadata pertaining to the operation's result.
                                                                                                	ResultMetadata middleware.Metadata
                                                                                                }

                                                                                                type ListTagsForResourceInput

                                                                                                type ListTagsForResourceInput struct {
                                                                                                
                                                                                                	// The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
                                                                                                	//
                                                                                                	// This member is required.
                                                                                                	ResourceArn *string
                                                                                                }

                                                                                                type ListTagsForResourceOutput

                                                                                                type ListTagsForResourceOutput struct {
                                                                                                
                                                                                                	// One or more tags.
                                                                                                	//
                                                                                                	// This member is required.
                                                                                                	TagList []types.Tag
                                                                                                
                                                                                                	// Metadata pertaining to the operation's result.
                                                                                                	ResultMetadata middleware.Metadata
                                                                                                }

                                                                                                type ModifyHapgInput

                                                                                                type ModifyHapgInput struct {
                                                                                                
                                                                                                	// The ARN of the high-availability partition group to modify.
                                                                                                	//
                                                                                                	// This member is required.
                                                                                                	HapgArn *string
                                                                                                
                                                                                                	// The new label for the high-availability partition group.
                                                                                                	Label *string
                                                                                                
                                                                                                	// The list of partition serial numbers to make members of the high-availability
                                                                                                	// partition group.
                                                                                                	PartitionSerialList []string
                                                                                                }

                                                                                                type ModifyHapgOutput

                                                                                                type ModifyHapgOutput struct {
                                                                                                
                                                                                                	// The ARN of the high-availability partition group.
                                                                                                	HapgArn *string
                                                                                                
                                                                                                	// Metadata pertaining to the operation's result.
                                                                                                	ResultMetadata middleware.Metadata
                                                                                                }

                                                                                                type ModifyHsmInput

                                                                                                type ModifyHsmInput struct {
                                                                                                
                                                                                                	// The ARN of the HSM to modify.
                                                                                                	//
                                                                                                	// This member is required.
                                                                                                	HsmArn *string
                                                                                                
                                                                                                	// 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
                                                                                                
                                                                                                	// The new external ID.
                                                                                                	ExternalId *string
                                                                                                
                                                                                                	// The new IAM role ARN.
                                                                                                	IamRoleArn *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
                                                                                                
                                                                                                	// The new IP address for the syslog monitoring server. The AWS CloudHSM service
                                                                                                	// only supports one syslog monitoring server.
                                                                                                	SyslogIp *string
                                                                                                }

                                                                                                  Contains the inputs for the ModifyHsm operation.

                                                                                                  type ModifyHsmOutput

                                                                                                  type ModifyHsmOutput struct {
                                                                                                  
                                                                                                  	// The ARN of the HSM.
                                                                                                  	HsmArn *string
                                                                                                  
                                                                                                  	// Metadata pertaining to the operation's result.
                                                                                                  	ResultMetadata middleware.Metadata
                                                                                                  }

                                                                                                    Contains the output of the ModifyHsm operation.

                                                                                                    type ModifyLunaClientInput

                                                                                                    type ModifyLunaClientInput struct {
                                                                                                    
                                                                                                    	// The new certificate for the client.
                                                                                                    	//
                                                                                                    	// This member is required.
                                                                                                    	Certificate *string
                                                                                                    
                                                                                                    	// The ARN of the client.
                                                                                                    	//
                                                                                                    	// This member is required.
                                                                                                    	ClientArn *string
                                                                                                    }

                                                                                                    type ModifyLunaClientOutput

                                                                                                    type ModifyLunaClientOutput struct {
                                                                                                    
                                                                                                    	// The ARN of the client.
                                                                                                    	ClientArn *string
                                                                                                    
                                                                                                    	// Metadata pertaining to the operation's result.
                                                                                                    	ResultMetadata middleware.Metadata
                                                                                                    }

                                                                                                    type Options

                                                                                                    type Options struct {
                                                                                                    	// Set of options to modify how an operation is invoked. These apply to all
                                                                                                    	// operations invoked for this client. Use functional options on operation call to
                                                                                                    	// modify this list for per operation behavior.
                                                                                                    	APIOptions []func(*middleware.Stack) error
                                                                                                    
                                                                                                    	// Configures the events that will be sent to the configured logger.
                                                                                                    	ClientLogMode aws.ClientLogMode
                                                                                                    
                                                                                                    	// The credentials object to use when signing requests.
                                                                                                    	Credentials aws.CredentialsProvider
                                                                                                    
                                                                                                    	// The endpoint options to be used when attempting to resolve an endpoint.
                                                                                                    	EndpointOptions EndpointResolverOptions
                                                                                                    
                                                                                                    	// The service endpoint resolver.
                                                                                                    	EndpointResolver EndpointResolver
                                                                                                    
                                                                                                    	// Signature Version 4 (SigV4) Signer
                                                                                                    	HTTPSignerV4 HTTPSignerV4
                                                                                                    
                                                                                                    	// The logger writer interface to write logging messages to.
                                                                                                    	Logger logging.Logger
                                                                                                    
                                                                                                    	// The region to send requests to. (Required)
                                                                                                    	Region string
                                                                                                    
                                                                                                    	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                                    	// failures. When nil the API client will use a default retryer.
                                                                                                    	Retryer aws.Retryer
                                                                                                    
                                                                                                    	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                                    	// implementation if nil.
                                                                                                    	HTTPClient HTTPClient
                                                                                                    }

                                                                                                    func (Options) Copy

                                                                                                    func (o Options) Copy() Options

                                                                                                      Copy creates a clone where the APIOptions list is deep copied.

                                                                                                      type RemoveTagsFromResourceInput

                                                                                                      type RemoveTagsFromResourceInput struct {
                                                                                                      
                                                                                                      	// The Amazon Resource Name (ARN) of the AWS CloudHSM resource.
                                                                                                      	//
                                                                                                      	// This member is required.
                                                                                                      	ResourceArn *string
                                                                                                      
                                                                                                      	// 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.
                                                                                                      	//
                                                                                                      	// This member is required.
                                                                                                      	TagKeyList []string
                                                                                                      }

                                                                                                      type RemoveTagsFromResourceOutput

                                                                                                      type RemoveTagsFromResourceOutput struct {
                                                                                                      
                                                                                                      	// The status of the operation.
                                                                                                      	//
                                                                                                      	// This member is required.
                                                                                                      	Status *string
                                                                                                      
                                                                                                      	// Metadata pertaining to the operation's result.
                                                                                                      	ResultMetadata middleware.Metadata
                                                                                                      }

                                                                                                      type ResolveEndpoint

                                                                                                      type ResolveEndpoint struct {
                                                                                                      	Resolver EndpointResolver
                                                                                                      	Options  EndpointResolverOptions
                                                                                                      }

                                                                                                      func (*ResolveEndpoint) HandleSerialize

                                                                                                      func (*ResolveEndpoint) ID

                                                                                                      func (*ResolveEndpoint) ID() string

                                                                                                      Directories

                                                                                                      Path Synopsis
                                                                                                      internal