func BackupPolicy_Values() []string
BackupPolicy_Values returns all elements of the BackupPolicy enum
func BackupRetentionType_Values() []string
BackupRetentionType_Values returns all elements of the BackupRetentionType enum
func BackupState_Values() []string
BackupState_Values returns all elements of the BackupState enum
func ClusterMode_Values() []string
ClusterMode_Values returns all elements of the ClusterMode enum
func ClusterState_Values() []string
ClusterState_Values returns all elements of the ClusterState enum
func HsmState_Values() []string
HsmState_Values returns all elements of the HsmState enum
type Backup struct { // The Amazon Resource Name (ARN) of the backup. BackupArn *string `type:"string"` // The identifier (ID) of the backup. // // BackupId is a required field BackupId *string `type:"string" required:"true"` // The state of the backup. BackupState *string `type:"string" enum:"BackupState"` // The identifier (ID) of the cluster that was backed up. ClusterId *string `type:"string"` // The date and time when the backup was copied from a source backup. CopyTimestamp *time.Time `type:"timestamp"` // The date and time when the backup was created. CreateTimestamp *time.Time `type:"timestamp"` // The date and time when the backup will be permanently deleted. DeleteTimestamp *time.Time `type:"timestamp"` // The HSM type used to create the backup. HsmType *string `type:"string"` // The mode of the cluster that was backed up. Mode *string `type:"string" enum:"ClusterMode"` // Specifies whether the service should exempt a backup from the retention policy // for the cluster. True exempts a backup from the retention policy. False means // the service applies the backup retention policy defined at the cluster. NeverExpires *bool `type:"boolean"` // The identifier (ID) of the source backup from which the new backup was copied. SourceBackup *string `type:"string"` // The identifier (ID) of the cluster containing the source backup from which // the new backup was copied. SourceCluster *string `type:"string"` // The AWS Region that contains the source backup from which the new backup // was copied. SourceRegion *string `type:"string"` // The list of tags for the backup. TagList []*Tag `min:"1" type:"list"` // contains filtered or unexported fields }
Contains information about a backup of an CloudHSM cluster. All backup objects contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. Backups that were copied into a destination region additionally contain the CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. A backup that is pending deletion will include the DeleteTimestamp parameter.
func (s Backup) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Backup) SetBackupArn(v string) *Backup
SetBackupArn sets the BackupArn field's value.
func (s *Backup) SetBackupId(v string) *Backup
SetBackupId sets the BackupId field's value.
func (s *Backup) SetBackupState(v string) *Backup
SetBackupState sets the BackupState field's value.
func (s *Backup) SetClusterId(v string) *Backup
SetClusterId sets the ClusterId field's value.
func (s *Backup) SetCopyTimestamp(v time.Time) *Backup
SetCopyTimestamp sets the CopyTimestamp field's value.
func (s *Backup) SetCreateTimestamp(v time.Time) *Backup
SetCreateTimestamp sets the CreateTimestamp field's value.
func (s *Backup) SetDeleteTimestamp(v time.Time) *Backup
SetDeleteTimestamp sets the DeleteTimestamp field's value.
func (s *Backup) SetHsmType(v string) *Backup
SetHsmType sets the HsmType field's value.
func (s *Backup) SetMode(v string) *Backup
SetMode sets the Mode field's value.
func (s *Backup) SetNeverExpires(v bool) *Backup
SetNeverExpires sets the NeverExpires field's value.
func (s *Backup) SetSourceBackup(v string) *Backup
SetSourceBackup sets the SourceBackup field's value.
func (s *Backup) SetSourceCluster(v string) *Backup
SetSourceCluster sets the SourceCluster field's value.
func (s *Backup) SetSourceRegion(v string) *Backup
SetSourceRegion sets the SourceRegion field's value.
func (s *Backup) SetTagList(v []*Tag) *Backup
SetTagList sets the TagList field's value.
func (s Backup) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type BackupRetentionPolicy struct { // The type of backup retention policy. For the DAYS type, the value is the // number of days to retain backups. Type *string `type:"string" enum:"BackupRetentionType"` // Use a value between 7 - 379. Value *string `min:"1" type:"string"` // contains filtered or unexported fields }
A policy that defines the number of days to retain backups.
func (s BackupRetentionPolicy) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BackupRetentionPolicy) SetType(v string) *BackupRetentionPolicy
SetType sets the Type field's value.
func (s *BackupRetentionPolicy) SetValue(v string) *BackupRetentionPolicy
SetValue sets the Value field's value.
func (s BackupRetentionPolicy) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *BackupRetentionPolicy) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Certificates struct { // The HSM hardware certificate issued (signed) by CloudHSM. AwsHardwareCertificate *string `type:"string"` // The cluster certificate issued (signed) by the issuing certificate authority // (CA) of the cluster's owner. ClusterCertificate *string `type:"string"` // The cluster's certificate signing request (CSR). The CSR exists only when // the cluster's state is UNINITIALIZED. ClusterCsr *string `type:"string"` // The HSM certificate issued (signed) by the HSM hardware. HsmCertificate *string `type:"string"` // The HSM hardware certificate issued (signed) by the hardware manufacturer. ManufacturerHardwareCertificate *string `type:"string"` // contains filtered or unexported fields }
Contains one or more certificates or a certificate signing request (CSR).
func (s Certificates) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Certificates) SetAwsHardwareCertificate(v string) *Certificates
SetAwsHardwareCertificate sets the AwsHardwareCertificate field's value.
func (s *Certificates) SetClusterCertificate(v string) *Certificates
SetClusterCertificate sets the ClusterCertificate field's value.
func (s *Certificates) SetClusterCsr(v string) *Certificates
SetClusterCsr sets the ClusterCsr field's value.
func (s *Certificates) SetHsmCertificate(v string) *Certificates
SetHsmCertificate sets the HsmCertificate field's value.
func (s *Certificates) SetManufacturerHardwareCertificate(v string) *Certificates
SetManufacturerHardwareCertificate sets the ManufacturerHardwareCertificate field's value.
func (s Certificates) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CloudHSMV2 struct { *client.Client }
CloudHSMV2 provides the API operation methods for making requests to AWS CloudHSM V2. See this package's package overview docs for details on the service.
CloudHSMV2 methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudHSMV2
New creates a new instance of the CloudHSMV2 client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
mySession := session.Must(session.NewSession()) // Create a CloudHSMV2 client from just a session. svc := cloudhsmv2.New(mySession) // Create a CloudHSMV2 client with additional configuration svc := cloudhsmv2.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (c *CloudHSMV2) CopyBackupToRegion(input *CopyBackupToRegionInput) (*CopyBackupToRegionOutput, error)
CopyBackupToRegion API operation for AWS CloudHSM V2.
Copy an CloudHSM cluster backup to a different region.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation CopyBackupToRegion for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CopyBackupToRegion
func (c *CloudHSMV2) CopyBackupToRegionRequest(input *CopyBackupToRegionInput) (req *request.Request, output *CopyBackupToRegionOutput)
CopyBackupToRegionRequest generates a "aws/request.Request" representing the client's request for the CopyBackupToRegion operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CopyBackupToRegion for more information on using the CopyBackupToRegion API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CopyBackupToRegionRequest method. req, resp := client.CopyBackupToRegionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CopyBackupToRegion
func (c *CloudHSMV2) CopyBackupToRegionWithContext(ctx aws.Context, input *CopyBackupToRegionInput, opts ...request.Option) (*CopyBackupToRegionOutput, error)
CopyBackupToRegionWithContext is the same as CopyBackupToRegion with the addition of the ability to pass a context and additional request options.
See CopyBackupToRegion for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)
CreateCluster API operation for AWS CloudHSM V2.
Creates a new CloudHSM cluster.
Cross-account use: Yes. To perform this operation with an CloudHSM backup in a different AWS account, specify the full backup ARN in the value of the SourceBackupId parameter.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation CreateCluster for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateCluster
func (c *CloudHSMV2) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)
CreateClusterRequest generates a "aws/request.Request" representing the client's request for the CreateCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateCluster for more information on using the CreateCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateClusterRequest method. req, resp := client.CreateClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateCluster
func (c *CloudHSMV2) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)
CreateClusterWithContext is the same as CreateCluster with the addition of the ability to pass a context and additional request options.
See CreateCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) CreateHsm(input *CreateHsmInput) (*CreateHsmOutput, error)
CreateHsm API operation for AWS CloudHSM V2.
Creates a new hardware security module (HSM) in the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Service account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation CreateHsm for usage and error information.
Returned Error Types:
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsm
func (c *CloudHSMV2) CreateHsmRequest(input *CreateHsmInput) (req *request.Request, output *CreateHsmOutput)
CreateHsmRequest generates a "aws/request.Request" representing the client's request for the CreateHsm operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateHsm for more information on using the CreateHsm API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateHsmRequest method. req, resp := client.CreateHsmRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsm
func (c *CloudHSMV2) CreateHsmWithContext(ctx aws.Context, input *CreateHsmInput, opts ...request.Option) (*CreateHsmOutput, error)
CreateHsmWithContext is the same as CreateHsm with the addition of the ability to pass a context and additional request options.
See CreateHsm for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) DeleteBackup(input *DeleteBackupInput) (*DeleteBackupOutput, error)
DeleteBackup API operation for AWS CloudHSM V2.
Deletes a specified CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request is made. For more information on restoring a backup, see RestoreBackup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DeleteBackup for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteBackup
func (c *CloudHSMV2) DeleteBackupRequest(input *DeleteBackupInput) (req *request.Request, output *DeleteBackupOutput)
DeleteBackupRequest generates a "aws/request.Request" representing the client's request for the DeleteBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteBackup for more information on using the DeleteBackup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteBackupRequest method. req, resp := client.DeleteBackupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteBackup
func (c *CloudHSMV2) DeleteBackupWithContext(ctx aws.Context, input *DeleteBackupInput, opts ...request.Option) (*DeleteBackupOutput, error)
DeleteBackupWithContext is the same as DeleteBackup with the addition of the ability to pass a context and additional request options.
See DeleteBackup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)
DeleteCluster API operation for AWS CloudHSM V2.
Deletes the specified CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DeleteCluster for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteCluster
func (c *CloudHSMV2) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)
DeleteClusterRequest generates a "aws/request.Request" representing the client's request for the DeleteCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteCluster for more information on using the DeleteCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteClusterRequest method. req, resp := client.DeleteClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteCluster
func (c *CloudHSMV2) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)
DeleteClusterWithContext is the same as DeleteCluster with the addition of the ability to pass a context and additional request options.
See DeleteCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) DeleteHsm(input *DeleteHsmInput) (*DeleteHsmOutput, error)
DeleteHsm API operation for AWS CloudHSM V2.
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
Cross-account use: No. You cannot perform this operation on an CloudHSM hsm in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DeleteHsm for usage and error information.
Returned Error Types:
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsm
func (c *CloudHSMV2) DeleteHsmRequest(input *DeleteHsmInput) (req *request.Request, output *DeleteHsmOutput)
DeleteHsmRequest generates a "aws/request.Request" representing the client's request for the DeleteHsm operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteHsm for more information on using the DeleteHsm API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteHsmRequest method. req, resp := client.DeleteHsmRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsm
func (c *CloudHSMV2) DeleteHsmWithContext(ctx aws.Context, input *DeleteHsmInput, opts ...request.Option) (*DeleteHsmOutput, error)
DeleteHsmWithContext is the same as DeleteHsm with the addition of the ability to pass a context and additional request options.
See DeleteHsm for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error)
DeleteResourcePolicy API operation for AWS CloudHSM V2.
Deletes an CloudHSM resource policy. Deleting a resource policy will result in the resource being unshared and removed from any RAM resource shares. Deleting the resource policy attached to a backup will not impact any clusters created from that backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DeleteResourcePolicy for usage and error information.
Returned Error Types:
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteResourcePolicy
func (c *CloudHSMV2) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput)
DeleteResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteResourcePolicy for more information on using the DeleteResourcePolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteResourcePolicyRequest method. req, resp := client.DeleteResourcePolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteResourcePolicy
func (c *CloudHSMV2) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error)
DeleteResourcePolicyWithContext is the same as DeleteResourcePolicy with the addition of the ability to pass a context and additional request options.
See DeleteResourcePolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) DescribeBackups(input *DescribeBackupsInput) (*DescribeBackupsOutput, error)
DescribeBackups API operation for AWS CloudHSM V2.
Gets information about backups of CloudHSM clusters. Lists either the backups you own or the backups shared with you when the Shared parameter is true.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.
Cross-account use: Yes. Customers can describe backups in other Amazon Web Services accounts that are shared with them.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DescribeBackups for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackups
func (c *CloudHSMV2) DescribeBackupsPages(input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool) error
DescribeBackupsPages iterates over the pages of a DescribeBackups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeBackups method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeBackups operation. pageNum := 0 err := client.DescribeBackupsPages(params, func(page *cloudhsmv2.DescribeBackupsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CloudHSMV2) DescribeBackupsPagesWithContext(ctx aws.Context, input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool, opts ...request.Option) error
DescribeBackupsPagesWithContext same as DescribeBackupsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) DescribeBackupsRequest(input *DescribeBackupsInput) (req *request.Request, output *DescribeBackupsOutput)
DescribeBackupsRequest generates a "aws/request.Request" representing the client's request for the DescribeBackups operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeBackups for more information on using the DescribeBackups API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeBackupsRequest method. req, resp := client.DescribeBackupsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackups
func (c *CloudHSMV2) DescribeBackupsWithContext(ctx aws.Context, input *DescribeBackupsInput, opts ...request.Option) (*DescribeBackupsOutput, error)
DescribeBackupsWithContext is the same as DescribeBackups with the addition of the ability to pass a context and additional request options.
See DescribeBackups for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) DescribeClusters(input *DescribeClustersInput) (*DescribeClustersOutput, error)
DescribeClusters API operation for AWS CloudHSM V2.
Gets information about CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.
Cross-account use: No. You cannot perform this operation on CloudHSM clusters in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DescribeClusters for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClusters
func (c *CloudHSMV2) DescribeClustersPages(input *DescribeClustersInput, fn func(*DescribeClustersOutput, bool) bool) error
DescribeClustersPages iterates over the pages of a DescribeClusters operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See DescribeClusters method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a DescribeClusters operation. pageNum := 0 err := client.DescribeClustersPages(params, func(page *cloudhsmv2.DescribeClustersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CloudHSMV2) DescribeClustersPagesWithContext(ctx aws.Context, input *DescribeClustersInput, fn func(*DescribeClustersOutput, bool) bool, opts ...request.Option) error
DescribeClustersPagesWithContext same as DescribeClustersPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) DescribeClustersRequest(input *DescribeClustersInput) (req *request.Request, output *DescribeClustersOutput)
DescribeClustersRequest generates a "aws/request.Request" representing the client's request for the DescribeClusters operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeClusters for more information on using the DescribeClusters API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeClustersRequest method. req, resp := client.DescribeClustersRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClusters
func (c *CloudHSMV2) DescribeClustersWithContext(ctx aws.Context, input *DescribeClustersInput, opts ...request.Option) (*DescribeClustersOutput, error)
DescribeClustersWithContext is the same as DescribeClusters with the addition of the ability to pass a context and additional request options.
See DescribeClusters for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) GetResourcePolicy(input *GetResourcePolicyInput) (*GetResourcePolicyOutput, error)
GetResourcePolicy API operation for AWS CloudHSM V2.
Retrieves the resource policy document attached to a given resource.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation GetResourcePolicy for usage and error information.
Returned Error Types:
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/GetResourcePolicy
func (c *CloudHSMV2) GetResourcePolicyRequest(input *GetResourcePolicyInput) (req *request.Request, output *GetResourcePolicyOutput)
GetResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the GetResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See GetResourcePolicy for more information on using the GetResourcePolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the GetResourcePolicyRequest method. req, resp := client.GetResourcePolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/GetResourcePolicy
func (c *CloudHSMV2) GetResourcePolicyWithContext(ctx aws.Context, input *GetResourcePolicyInput, opts ...request.Option) (*GetResourcePolicyOutput, error)
GetResourcePolicyWithContext is the same as GetResourcePolicy with the addition of the ability to pass a context and additional request options.
See GetResourcePolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) InitializeCluster(input *InitializeClusterInput) (*InitializeClusterOutput, error)
InitializeCluster API operation for AWS CloudHSM V2.
Claims an CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation InitializeCluster for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeCluster
func (c *CloudHSMV2) InitializeClusterRequest(input *InitializeClusterInput) (req *request.Request, output *InitializeClusterOutput)
InitializeClusterRequest generates a "aws/request.Request" representing the client's request for the InitializeCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See InitializeCluster for more information on using the InitializeCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the InitializeClusterRequest method. req, resp := client.InitializeClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeCluster
func (c *CloudHSMV2) InitializeClusterWithContext(ctx aws.Context, input *InitializeClusterInput, opts ...request.Option) (*InitializeClusterOutput, error)
InitializeClusterWithContext is the same as InitializeCluster with the addition of the ability to pass a context and additional request options.
See InitializeCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) ListTags(input *ListTagsInput) (*ListTagsOutput, error)
ListTags API operation for AWS CloudHSM V2.
Gets a list of tags for the specified CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation ListTags for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTags
func (c *CloudHSMV2) ListTagsPages(input *ListTagsInput, fn func(*ListTagsOutput, bool) bool) error
ListTagsPages iterates over the pages of a ListTags operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListTags method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTags operation. pageNum := 0 err := client.ListTagsPages(params, func(page *cloudhsmv2.ListTagsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (c *CloudHSMV2) ListTagsPagesWithContext(ctx aws.Context, input *ListTagsInput, fn func(*ListTagsOutput, bool) bool, opts ...request.Option) error
ListTagsPagesWithContext same as ListTagsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)
ListTagsRequest generates a "aws/request.Request" representing the client's request for the ListTags operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTags for more information on using the ListTags API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTagsRequest method. req, resp := client.ListTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTags
func (c *CloudHSMV2) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)
ListTagsWithContext is the same as ListTags with the addition of the ability to pass a context and additional request options.
See ListTags for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) ModifyBackupAttributes(input *ModifyBackupAttributesInput) (*ModifyBackupAttributesOutput, error)
ModifyBackupAttributes API operation for AWS CloudHSM V2.
Modifies attributes for CloudHSM backup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation ModifyBackupAttributes for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyBackupAttributes
func (c *CloudHSMV2) ModifyBackupAttributesRequest(input *ModifyBackupAttributesInput) (req *request.Request, output *ModifyBackupAttributesOutput)
ModifyBackupAttributesRequest generates a "aws/request.Request" representing the client's request for the ModifyBackupAttributes operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ModifyBackupAttributes for more information on using the ModifyBackupAttributes API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ModifyBackupAttributesRequest method. req, resp := client.ModifyBackupAttributesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyBackupAttributes
func (c *CloudHSMV2) ModifyBackupAttributesWithContext(ctx aws.Context, input *ModifyBackupAttributesInput, opts ...request.Option) (*ModifyBackupAttributesOutput, error)
ModifyBackupAttributesWithContext is the same as ModifyBackupAttributes with the addition of the ability to pass a context and additional request options.
See ModifyBackupAttributes for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) ModifyCluster(input *ModifyClusterInput) (*ModifyClusterOutput, error)
ModifyCluster API operation for AWS CloudHSM V2.
Modifies CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM cluster in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation ModifyCluster for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyCluster
func (c *CloudHSMV2) ModifyClusterRequest(input *ModifyClusterInput) (req *request.Request, output *ModifyClusterOutput)
ModifyClusterRequest generates a "aws/request.Request" representing the client's request for the ModifyCluster operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ModifyCluster for more information on using the ModifyCluster API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ModifyClusterRequest method. req, resp := client.ModifyClusterRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ModifyCluster
func (c *CloudHSMV2) ModifyClusterWithContext(ctx aws.Context, input *ModifyClusterInput, opts ...request.Option) (*ModifyClusterOutput, error)
ModifyClusterWithContext is the same as ModifyCluster with the addition of the ability to pass a context and additional request options.
See ModifyCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error)
PutResourcePolicy API operation for AWS CloudHSM V2.
Creates or updates an CloudHSM resource policy. A resource policy helps you to define the IAM entity (for example, an Amazon Web Services account) that can manage your CloudHSM resources. The following resources support CloudHSM resource policies:
In order to share a backup, it must be in a 'READY' state and you must own it.
While you can share a backup using the CloudHSM PutResourcePolicy operation, we recommend using Resource Access Manager (RAM) instead. Using RAM provides multiple benefits as it creates the policy for you, allows multiple resources to be shared at one time, and increases the discoverability of shared resources. If you use PutResourcePolicy and want consumers to be able to describe the backups you share with them, you must promote the backup to a standard RAM Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation. For more information, see Working with shared backups (https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html) in the CloudHSM User Guide
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation PutResourcePolicy for usage and error information.
Returned Error Types:
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/PutResourcePolicy
func (c *CloudHSMV2) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput)
PutResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the PutResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See PutResourcePolicy for more information on using the PutResourcePolicy API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the PutResourcePolicyRequest method. req, resp := client.PutResourcePolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/PutResourcePolicy
func (c *CloudHSMV2) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error)
PutResourcePolicyWithContext is the same as PutResourcePolicy with the addition of the ability to pass a context and additional request options.
See PutResourcePolicy for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) RestoreBackup(input *RestoreBackupInput) (*RestoreBackupOutput, error)
RestoreBackup API operation for AWS CloudHSM V2.
Restores a specified CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.
Cross-account use: No. You cannot perform this operation on an CloudHSM backup in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation RestoreBackup for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/RestoreBackup
func (c *CloudHSMV2) RestoreBackupRequest(input *RestoreBackupInput) (req *request.Request, output *RestoreBackupOutput)
RestoreBackupRequest generates a "aws/request.Request" representing the client's request for the RestoreBackup operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See RestoreBackup for more information on using the RestoreBackup API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the RestoreBackupRequest method. req, resp := client.RestoreBackupRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/RestoreBackup
func (c *CloudHSMV2) RestoreBackupWithContext(ctx aws.Context, input *RestoreBackupInput, opts ...request.Option) (*RestoreBackupOutput, error)
RestoreBackupWithContext is the same as RestoreBackup with the addition of the ability to pass a context and additional request options.
See RestoreBackup for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for AWS CloudHSM V2.
Adds or overwrites one or more tags for the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation TagResource for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResource
func (c *CloudHSMV2) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TagResource for more information on using the TagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TagResourceRequest method. req, resp := client.TagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResource
func (c *CloudHSMV2) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.
See TagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (c *CloudHSMV2) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for AWS CloudHSM V2.
Removes the specified tag or tags from the specified CloudHSM cluster.
Cross-account use: No. You cannot perform this operation on an CloudHSM resource in a different Amazon Web Services account.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation UntagResource for usage and error information.
Returned Error Types:
CloudHsmAccessDeniedException The request was rejected because the requester does not have permission to perform the requested operation.
CloudHsmInternalFailureException The request was rejected because of an CloudHSM internal failure. The request can be retried.
CloudHsmInvalidRequestException The request was rejected because it is not a valid request.
CloudHsmResourceNotFoundException The request was rejected because it refers to a resource that cannot be found.
CloudHsmServiceException The request was rejected because an error occurred.
CloudHsmTagException The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResource
func (c *CloudHSMV2) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UntagResource for more information on using the UntagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UntagResourceRequest method. req, resp := client.UntagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResource
func (c *CloudHSMV2) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.
See UntagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type CloudHsmAccessDeniedException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The request was rejected because the requester does not have permission to perform the requested operation.
func (s *CloudHsmAccessDeniedException) Code() string
Code returns the exception type name.
func (s *CloudHsmAccessDeniedException) Error() string
func (s CloudHsmAccessDeniedException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CloudHsmAccessDeniedException) Message() string
Message returns the exception's message.
func (s *CloudHsmAccessDeniedException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *CloudHsmAccessDeniedException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *CloudHsmAccessDeniedException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s CloudHsmAccessDeniedException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CloudHsmInternalFailureException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The request was rejected because of an CloudHSM internal failure. The request can be retried.
func (s *CloudHsmInternalFailureException) Code() string
Code returns the exception type name.
func (s *CloudHsmInternalFailureException) Error() string
func (s CloudHsmInternalFailureException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CloudHsmInternalFailureException) Message() string
Message returns the exception's message.
func (s *CloudHsmInternalFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *CloudHsmInternalFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *CloudHsmInternalFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s CloudHsmInternalFailureException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CloudHsmInvalidRequestException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The request was rejected because it is not a valid request.
func (s *CloudHsmInvalidRequestException) Code() string
Code returns the exception type name.
func (s *CloudHsmInvalidRequestException) Error() string
func (s CloudHsmInvalidRequestException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CloudHsmInvalidRequestException) Message() string
Message returns the exception's message.
func (s *CloudHsmInvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *CloudHsmInvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *CloudHsmInvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s CloudHsmInvalidRequestException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CloudHsmResourceNotFoundException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The request was rejected because it refers to a resource that cannot be found.
func (s *CloudHsmResourceNotFoundException) Code() string
Code returns the exception type name.
func (s *CloudHsmResourceNotFoundException) Error() string
func (s CloudHsmResourceNotFoundException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CloudHsmResourceNotFoundException) Message() string
Message returns the exception's message.
func (s *CloudHsmResourceNotFoundException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *CloudHsmResourceNotFoundException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *CloudHsmResourceNotFoundException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s CloudHsmResourceNotFoundException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CloudHsmServiceException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The request was rejected because an error occurred.
func (s *CloudHsmServiceException) Code() string
Code returns the exception type name.
func (s *CloudHsmServiceException) Error() string
func (s CloudHsmServiceException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CloudHsmServiceException) Message() string
Message returns the exception's message.
func (s *CloudHsmServiceException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *CloudHsmServiceException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *CloudHsmServiceException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s CloudHsmServiceException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CloudHsmTagException struct { RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` Message_ *string `locationName:"Message" type:"string"` // contains filtered or unexported fields }
The request was rejected because of a tagging failure. Verify the tag conditions in all applicable policies, and then retry the request.
func (s *CloudHsmTagException) Code() string
Code returns the exception type name.
func (s *CloudHsmTagException) Error() string
func (s CloudHsmTagException) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CloudHsmTagException) Message() string
Message returns the exception's message.
func (s *CloudHsmTagException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *CloudHsmTagException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *CloudHsmTagException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s CloudHsmTagException) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Cluster struct { // The cluster's backup policy. BackupPolicy *string `type:"string" enum:"BackupPolicy"` // A policy that defines how the service retains backups. BackupRetentionPolicy *BackupRetentionPolicy `type:"structure"` // Contains one or more certificates or a certificate signing request (CSR). Certificates *Certificates `type:"structure"` // The cluster's identifier (ID). ClusterId *string `type:"string"` // The date and time when the cluster was created. CreateTimestamp *time.Time `type:"timestamp"` // The type of HSM that the cluster contains. HsmType *string `type:"string"` // Contains information about the HSMs in the cluster. Hsms []*Hsm `type:"list"` // The mode of the cluster. Mode *string `type:"string" enum:"ClusterMode"` // The default password for the cluster's Pre-Crypto Officer (PRECO) user. PreCoPassword *string `min:"7" type:"string"` // The identifier (ID) of the cluster's security group. SecurityGroup *string `type:"string"` // The identifier (ID) of the backup used to create the cluster. This value // exists only when the cluster was created from a backup. SourceBackupId *string `type:"string"` // The cluster's state. State *string `type:"string" enum:"ClusterState"` // A description of the cluster's state. StateMessage *string `type:"string"` // A map from availability zone to the cluster’s subnet in that availability // zone. SubnetMapping map[string]*string `type:"map"` // The list of tags for the cluster. TagList []*Tag `min:"1" type:"list"` // The identifier (ID) of the virtual private cloud (VPC) that contains the // cluster. VpcId *string `type:"string"` // contains filtered or unexported fields }
Contains information about an CloudHSM cluster.
func (s Cluster) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Cluster) SetBackupPolicy(v string) *Cluster
SetBackupPolicy sets the BackupPolicy field's value.
func (s *Cluster) SetBackupRetentionPolicy(v *BackupRetentionPolicy) *Cluster
SetBackupRetentionPolicy sets the BackupRetentionPolicy field's value.
func (s *Cluster) SetCertificates(v *Certificates) *Cluster
SetCertificates sets the Certificates field's value.
func (s *Cluster) SetClusterId(v string) *Cluster
SetClusterId sets the ClusterId field's value.
func (s *Cluster) SetCreateTimestamp(v time.Time) *Cluster
SetCreateTimestamp sets the CreateTimestamp field's value.
func (s *Cluster) SetHsmType(v string) *Cluster
SetHsmType sets the HsmType field's value.
func (s *Cluster) SetHsms(v []*Hsm) *Cluster
SetHsms sets the Hsms field's value.
func (s *Cluster) SetMode(v string) *Cluster
SetMode sets the Mode field's value.
func (s *Cluster) SetPreCoPassword(v string) *Cluster
SetPreCoPassword sets the PreCoPassword field's value.
func (s *Cluster) SetSecurityGroup(v string) *Cluster
SetSecurityGroup sets the SecurityGroup field's value.
func (s *Cluster) SetSourceBackupId(v string) *Cluster
SetSourceBackupId sets the SourceBackupId field's value.
func (s *Cluster) SetState(v string) *Cluster
SetState sets the State field's value.
func (s *Cluster) SetStateMessage(v string) *Cluster
SetStateMessage sets the StateMessage field's value.
func (s *Cluster) SetSubnetMapping(v map[string]*string) *Cluster
SetSubnetMapping sets the SubnetMapping field's value.
func (s *Cluster) SetTagList(v []*Tag) *Cluster
SetTagList sets the TagList field's value.
func (s *Cluster) SetVpcId(v string) *Cluster
SetVpcId sets the VpcId field's value.
func (s Cluster) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CopyBackupToRegionInput struct { // The ID of the backup that will be copied to the destination region. // // BackupId is a required field BackupId *string `type:"string" required:"true"` // The AWS region that will contain your copied CloudHSM cluster backup. // // DestinationRegion is a required field DestinationRegion *string `type:"string" required:"true"` // Tags to apply to the destination backup during creation. If you specify tags, // only these tags will be applied to the destination backup. If you do not // specify tags, the service copies tags from the source backup to the destination // backup. TagList []*Tag `min:"1" type:"list"` // contains filtered or unexported fields }
func (s CopyBackupToRegionInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CopyBackupToRegionInput) SetBackupId(v string) *CopyBackupToRegionInput
SetBackupId sets the BackupId field's value.
func (s *CopyBackupToRegionInput) SetDestinationRegion(v string) *CopyBackupToRegionInput
SetDestinationRegion sets the DestinationRegion field's value.
func (s *CopyBackupToRegionInput) SetTagList(v []*Tag) *CopyBackupToRegionInput
SetTagList sets the TagList field's value.
func (s CopyBackupToRegionInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CopyBackupToRegionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CopyBackupToRegionOutput struct { // Information on the backup that will be copied to the destination region, // including CreateTimestamp, SourceBackup, SourceCluster, and Source Region. // CreateTimestamp of the destination backup will be the same as that of the // source backup. // // You will need to use the sourceBackupID returned in this operation to use // the DescribeBackups operation on the backup that will be copied to the destination // region. DestinationBackup *DestinationBackup `type:"structure"` // contains filtered or unexported fields }
func (s CopyBackupToRegionOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CopyBackupToRegionOutput) SetDestinationBackup(v *DestinationBackup) *CopyBackupToRegionOutput
SetDestinationBackup sets the DestinationBackup field's value.
func (s CopyBackupToRegionOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateClusterInput struct { // A policy that defines how the service retains backups. BackupRetentionPolicy *BackupRetentionPolicy `type:"structure"` // The type of HSM to use in the cluster. The allowed values are hsm1.medium // and hsm2m.medium. // // HsmType is a required field HsmType *string `type:"string" required:"true"` // The mode to use in the cluster. The allowed values are FIPS and NON_FIPS. Mode *string `type:"string" enum:"ClusterMode"` // The identifier (ID) or the Amazon Resource Name (ARN) of the cluster backup // to restore. Use this value to restore the cluster from a backup instead of // creating a new cluster. To find the backup ID or ARN, use DescribeBackups. // If using a backup in another account, the full ARN must be supplied. SourceBackupId *string `type:"string"` // The identifiers (IDs) of the subnets where you are creating the cluster. // You must specify at least one subnet. If you specify multiple subnets, they // must meet the following criteria: // // * All subnets must be in the same virtual private cloud (VPC). // // * You can specify only one subnet per Availability Zone. // // SubnetIds is a required field SubnetIds []*string `min:"1" type:"list" required:"true"` // Tags to apply to the CloudHSM cluster during creation. TagList []*Tag `min:"1" type:"list"` // contains filtered or unexported fields }
func (s CreateClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateClusterInput) SetBackupRetentionPolicy(v *BackupRetentionPolicy) *CreateClusterInput
SetBackupRetentionPolicy sets the BackupRetentionPolicy field's value.
func (s *CreateClusterInput) SetHsmType(v string) *CreateClusterInput
SetHsmType sets the HsmType field's value.
func (s *CreateClusterInput) SetMode(v string) *CreateClusterInput
SetMode sets the Mode field's value.
func (s *CreateClusterInput) SetSourceBackupId(v string) *CreateClusterInput
SetSourceBackupId sets the SourceBackupId field's value.
func (s *CreateClusterInput) SetSubnetIds(v []*string) *CreateClusterInput
SetSubnetIds sets the SubnetIds field's value.
func (s *CreateClusterInput) SetTagList(v []*Tag) *CreateClusterInput
SetTagList sets the TagList field's value.
func (s CreateClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateClusterOutput struct { // Information about the cluster that was created. Cluster *Cluster `type:"structure"` // contains filtered or unexported fields }
func (s CreateClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateClusterOutput) SetCluster(v *Cluster) *CreateClusterOutput
SetCluster sets the Cluster field's value.
func (s CreateClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type CreateHsmInput struct { // The Availability Zone where you are creating the HSM. To find the cluster's // Availability Zones, use DescribeClusters. // // AvailabilityZone is a required field AvailabilityZone *string `type:"string" required:"true"` // The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters. // // ClusterId is a required field ClusterId *string `type:"string" required:"true"` // The HSM's IP address. If you specify an IP address, use an available address // from the subnet that maps to the Availability Zone where you are creating // the HSM. If you don't specify an IP address, one is chosen for you from that // subnet. IpAddress *string `type:"string"` // contains filtered or unexported fields }
func (s CreateHsmInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateHsmInput) SetAvailabilityZone(v string) *CreateHsmInput
SetAvailabilityZone sets the AvailabilityZone field's value.
func (s *CreateHsmInput) SetClusterId(v string) *CreateHsmInput
SetClusterId sets the ClusterId field's value.
func (s *CreateHsmInput) SetIpAddress(v string) *CreateHsmInput
SetIpAddress sets the IpAddress field's value.
func (s CreateHsmInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateHsmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateHsmOutput struct { // Information about the HSM that was created. Hsm *Hsm `type:"structure"` // contains filtered or unexported fields }
func (s CreateHsmOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *CreateHsmOutput) SetHsm(v *Hsm) *CreateHsmOutput
SetHsm sets the Hsm field's value.
func (s CreateHsmOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteBackupInput struct { // The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups // operation. // // BackupId is a required field BackupId *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteBackupInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteBackupInput) SetBackupId(v string) *DeleteBackupInput
SetBackupId sets the BackupId field's value.
func (s DeleteBackupInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBackupOutput struct { // Information on the Backup object deleted. Backup *Backup `type:"structure"` // contains filtered or unexported fields }
func (s DeleteBackupOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteBackupOutput) SetBackup(v *Backup) *DeleteBackupOutput
SetBackup sets the Backup field's value.
func (s DeleteBackupOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteClusterInput struct { // The identifier (ID) of the cluster that you are deleting. To find the cluster // ID, use DescribeClusters. // // ClusterId is a required field ClusterId *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s DeleteClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteClusterInput) SetClusterId(v string) *DeleteClusterInput
SetClusterId sets the ClusterId field's value.
func (s DeleteClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteClusterOutput struct { // Information about the cluster that was deleted. Cluster *Cluster `type:"structure"` // contains filtered or unexported fields }
func (s DeleteClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteClusterOutput) SetCluster(v *Cluster) *DeleteClusterOutput
SetCluster sets the Cluster field's value.
func (s DeleteClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteHsmInput struct { // The identifier (ID) of the cluster that contains the HSM that you are deleting. // // ClusterId is a required field ClusterId *string `type:"string" required:"true"` // The identifier (ID) of the elastic network interface (ENI) of the HSM that // you are deleting. EniId *string `type:"string"` // The IP address of the elastic network interface (ENI) of the HSM that you // are deleting. EniIp *string `type:"string"` // The identifier (ID) of the HSM that you are deleting. HsmId *string `type:"string"` // contains filtered or unexported fields }
func (s DeleteHsmInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteHsmInput) SetClusterId(v string) *DeleteHsmInput
SetClusterId sets the ClusterId field's value.
func (s *DeleteHsmInput) SetEniId(v string) *DeleteHsmInput
SetEniId sets the EniId field's value.
func (s *DeleteHsmInput) SetEniIp(v string) *DeleteHsmInput
SetEniIp sets the EniIp field's value.
func (s *DeleteHsmInput) SetHsmId(v string) *DeleteHsmInput
SetHsmId sets the HsmId field's value.
func (s DeleteHsmInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteHsmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteHsmOutput struct { // The identifier (ID) of the HSM that was deleted. HsmId *string `type:"string"` // contains filtered or unexported fields }
func (s DeleteHsmOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteHsmOutput) SetHsmId(v string) *DeleteHsmOutput
SetHsmId sets the HsmId field's value.
func (s DeleteHsmOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteResourcePolicyInput struct { // Amazon Resource Name (ARN) of the resource from which the policy will be // removed. ResourceArn *string `type:"string"` // contains filtered or unexported fields }
func (s DeleteResourcePolicyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteResourcePolicyInput) SetResourceArn(v string) *DeleteResourcePolicyInput
SetResourceArn sets the ResourceArn field's value.
func (s DeleteResourcePolicyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DeleteResourcePolicyOutput struct { // The policy previously attached to the resource. Policy *string `min:"1" type:"string"` // Amazon Resource Name (ARN) of the resource from which the policy was deleted. ResourceArn *string `type:"string"` // contains filtered or unexported fields }
func (s DeleteResourcePolicyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DeleteResourcePolicyOutput) SetPolicy(v string) *DeleteResourcePolicyOutput
SetPolicy sets the Policy field's value.
func (s *DeleteResourcePolicyOutput) SetResourceArn(v string) *DeleteResourcePolicyOutput
SetResourceArn sets the ResourceArn field's value.
func (s DeleteResourcePolicyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeBackupsInput struct { // One or more filters to limit the items returned in the response. // // Use the backupIds filter to return only the specified backups. Specify backups // by their backup identifier (ID). // // Use the sourceBackupIds filter to return only the backups created from a // source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion // operation. // // Use the clusterIds filter to return only the backups for the specified clusters. // Specify clusters by their cluster identifier (ID). // // Use the states filter to return only backups that match the specified state. // // Use the neverExpires filter to return backups filtered by the value in the // neverExpires parameter. True returns all backups exempt from the backup retention // policy. False returns all backups with a backup retention policy defined // at the cluster. Filters map[string][]*string `type:"map"` // The maximum number of backups to return in the response. When there are more // backups than the number you specify, the response contains a NextToken value. MaxResults *int64 `min:"1" type:"integer"` // The NextToken value that you received in the previous response. Use this // value to get more backups. NextToken *string `type:"string"` // Describe backups that are shared with you. // // By default when using this option, the command returns backups that have // been shared using a standard Resource Access Manager resource share. In order // for a backup that was shared using the PutResourcePolicy command to be returned, // the share must be promoted to a standard resource share using the RAM PromoteResourceShareCreatedFromPolicy // (https://docs.aws.amazon.com/cli/latest/reference/ram/promote-resource-share-created-from-policy.html) // API operation. For more information about sharing backups, see Working with // shared backups (https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html) // in the CloudHSM User Guide. Shared *bool `type:"boolean"` // Designates whether or not to sort the return backups by ascending chronological // order of generation. SortAscending *bool `type:"boolean"` // contains filtered or unexported fields }
func (s DescribeBackupsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeBackupsInput) SetFilters(v map[string][]*string) *DescribeBackupsInput
SetFilters sets the Filters field's value.
func (s *DescribeBackupsInput) SetMaxResults(v int64) *DescribeBackupsInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribeBackupsInput) SetNextToken(v string) *DescribeBackupsInput
SetNextToken sets the NextToken field's value.
func (s *DescribeBackupsInput) SetShared(v bool) *DescribeBackupsInput
SetShared sets the Shared field's value.
func (s *DescribeBackupsInput) SetSortAscending(v bool) *DescribeBackupsInput
SetSortAscending sets the SortAscending field's value.
func (s DescribeBackupsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeBackupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeBackupsOutput struct { // A list of backups. Backups []*Backup `type:"list"` // An opaque string that indicates that the response contains only a subset // of backups. Use this value in a subsequent DescribeBackups request to get // more backups. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (s DescribeBackupsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeBackupsOutput) SetBackups(v []*Backup) *DescribeBackupsOutput
SetBackups sets the Backups field's value.
func (s *DescribeBackupsOutput) SetNextToken(v string) *DescribeBackupsOutput
SetNextToken sets the NextToken field's value.
func (s DescribeBackupsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DescribeClustersInput struct { // One or more filters to limit the items returned in the response. // // Use the clusterIds filter to return only the specified clusters. Specify // clusters by their cluster identifier (ID). // // Use the vpcIds filter to return only the clusters in the specified virtual // private clouds (VPCs). Specify VPCs by their VPC identifier (ID). // // Use the states filter to return only clusters that match the specified state. Filters map[string][]*string `type:"map"` // The maximum number of clusters to return in the response. When there are // more clusters than the number you specify, the response contains a NextToken // value. MaxResults *int64 `min:"1" type:"integer"` // The NextToken value that you received in the previous response. Use this // value to get more clusters. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (s DescribeClustersInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeClustersInput) SetFilters(v map[string][]*string) *DescribeClustersInput
SetFilters sets the Filters field's value.
func (s *DescribeClustersInput) SetMaxResults(v int64) *DescribeClustersInput
SetMaxResults sets the MaxResults field's value.
func (s *DescribeClustersInput) SetNextToken(v string) *DescribeClustersInput
SetNextToken sets the NextToken field's value.
func (s DescribeClustersInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeClustersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeClustersOutput struct { // A list of clusters. Clusters []*Cluster `type:"list"` // An opaque string that indicates that the response contains only a subset // of clusters. Use this value in a subsequent DescribeClusters request to get // more clusters. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (s DescribeClustersOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DescribeClustersOutput) SetClusters(v []*Cluster) *DescribeClustersOutput
SetClusters sets the Clusters field's value.
func (s *DescribeClustersOutput) SetNextToken(v string) *DescribeClustersOutput
SetNextToken sets the NextToken field's value.
func (s DescribeClustersOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type DestinationBackup struct { // The date and time when both the source backup was created. CreateTimestamp *time.Time `type:"timestamp"` // The identifier (ID) of the source backup from which the new backup was copied. SourceBackup *string `type:"string"` // The identifier (ID) of the cluster containing the source backup from which // the new backup was copied. SourceCluster *string `type:"string"` // The AWS region that contains the source backup from which the new backup // was copied. SourceRegion *string `type:"string"` // contains filtered or unexported fields }
Contains information about the backup that will be copied and created by the CopyBackupToRegion operation.
func (s DestinationBackup) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *DestinationBackup) SetCreateTimestamp(v time.Time) *DestinationBackup
SetCreateTimestamp sets the CreateTimestamp field's value.
func (s *DestinationBackup) SetSourceBackup(v string) *DestinationBackup
SetSourceBackup sets the SourceBackup field's value.
func (s *DestinationBackup) SetSourceCluster(v string) *DestinationBackup
SetSourceCluster sets the SourceCluster field's value.
func (s *DestinationBackup) SetSourceRegion(v string) *DestinationBackup
SetSourceRegion sets the SourceRegion field's value.
func (s DestinationBackup) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetResourcePolicyInput struct { // Amazon Resource Name (ARN) of the resource to which a policy is attached. ResourceArn *string `type:"string"` // contains filtered or unexported fields }
func (s GetResourcePolicyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetResourcePolicyInput) SetResourceArn(v string) *GetResourcePolicyInput
SetResourceArn sets the ResourceArn field's value.
func (s GetResourcePolicyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type GetResourcePolicyOutput struct { // The policy attached to a resource. Policy *string `min:"1" type:"string"` // contains filtered or unexported fields }
func (s GetResourcePolicyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *GetResourcePolicyOutput) SetPolicy(v string) *GetResourcePolicyOutput
SetPolicy sets the Policy field's value.
func (s GetResourcePolicyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Hsm struct { // The Availability Zone that contains the HSM. AvailabilityZone *string `type:"string"` // The identifier (ID) of the cluster that contains the HSM. ClusterId *string `type:"string"` // The identifier (ID) of the HSM's elastic network interface (ENI). EniId *string `type:"string"` // The IP address of the HSM's elastic network interface (ENI). EniIp *string `type:"string"` // The HSM's identifier (ID). // // HsmId is a required field HsmId *string `type:"string" required:"true"` // The HSM's state. State *string `type:"string" enum:"HsmState"` // A description of the HSM's state. StateMessage *string `type:"string"` // The subnet that contains the HSM's elastic network interface (ENI). SubnetId *string `type:"string"` // contains filtered or unexported fields }
Contains information about a hardware security module (HSM) in an CloudHSM cluster.
func (s Hsm) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Hsm) SetAvailabilityZone(v string) *Hsm
SetAvailabilityZone sets the AvailabilityZone field's value.
func (s *Hsm) SetClusterId(v string) *Hsm
SetClusterId sets the ClusterId field's value.
func (s *Hsm) SetEniId(v string) *Hsm
SetEniId sets the EniId field's value.
func (s *Hsm) SetEniIp(v string) *Hsm
SetEniIp sets the EniIp field's value.
func (s *Hsm) SetHsmId(v string) *Hsm
SetHsmId sets the HsmId field's value.
func (s *Hsm) SetState(v string) *Hsm
SetState sets the State field's value.
func (s *Hsm) SetStateMessage(v string) *Hsm
SetStateMessage sets the StateMessage field's value.
func (s *Hsm) SetSubnetId(v string) *Hsm
SetSubnetId sets the SubnetId field's value.
func (s Hsm) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type InitializeClusterInput struct { // The identifier (ID) of the cluster that you are claiming. To find the cluster // ID, use DescribeClusters. // // ClusterId is a required field ClusterId *string `type:"string" required:"true"` // The cluster certificate issued (signed) by your issuing certificate authority // (CA). The certificate must be in PEM format and can contain a maximum of // 5000 characters. // // SignedCert is a required field SignedCert *string `type:"string" required:"true"` // The issuing certificate of the issuing certificate authority (CA) that issued // (signed) the cluster certificate. You must use a self-signed certificate. // The certificate used to sign the HSM CSR must be directly available, and // thus must be the root certificate. The certificate must be in PEM format // and can contain a maximum of 5000 characters. // // TrustAnchor is a required field TrustAnchor *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s InitializeClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InitializeClusterInput) SetClusterId(v string) *InitializeClusterInput
SetClusterId sets the ClusterId field's value.
func (s *InitializeClusterInput) SetSignedCert(v string) *InitializeClusterInput
SetSignedCert sets the SignedCert field's value.
func (s *InitializeClusterInput) SetTrustAnchor(v string) *InitializeClusterInput
SetTrustAnchor sets the TrustAnchor field's value.
func (s InitializeClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InitializeClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InitializeClusterOutput struct { // The cluster's state. State *string `type:"string" enum:"ClusterState"` // A description of the cluster's state. StateMessage *string `type:"string"` // contains filtered or unexported fields }
func (s InitializeClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *InitializeClusterOutput) SetState(v string) *InitializeClusterOutput
SetState sets the State field's value.
func (s *InitializeClusterOutput) SetStateMessage(v string) *InitializeClusterOutput
SetStateMessage sets the StateMessage field's value.
func (s InitializeClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ListTagsInput struct { // The maximum number of tags to return in the response. When there are more // tags than the number you specify, the response contains a NextToken value. MaxResults *int64 `min:"1" type:"integer"` // The NextToken value that you received in the previous response. Use this // value to get more tags. NextToken *string `type:"string"` // The cluster identifier (ID) for the cluster whose tags you are getting. To // find the cluster ID, use DescribeClusters. // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s ListTagsInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsInput) SetMaxResults(v int64) *ListTagsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListTagsInput) SetNextToken(v string) *ListTagsInput
SetNextToken sets the NextToken field's value.
func (s *ListTagsInput) SetResourceId(v string) *ListTagsInput
SetResourceId sets the ResourceId field's value.
func (s ListTagsInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsOutput struct { // An opaque string that indicates that the response contains only a subset // of tags. Use this value in a subsequent ListTags request to get more tags. NextToken *string `type:"string"` // A list of tags. // // TagList is a required field TagList []*Tag `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (s ListTagsOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ListTagsOutput) SetNextToken(v string) *ListTagsOutput
SetNextToken sets the NextToken field's value.
func (s *ListTagsOutput) SetTagList(v []*Tag) *ListTagsOutput
SetTagList sets the TagList field's value.
func (s ListTagsOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ModifyBackupAttributesInput struct { // The identifier (ID) of the backup to modify. To find the ID of a backup, // use the DescribeBackups operation. // // BackupId is a required field BackupId *string `type:"string" required:"true"` // Specifies whether the service should exempt a backup from the retention policy // for the cluster. True exempts a backup from the retention policy. False means // the service applies the backup retention policy defined at the cluster. // // NeverExpires is a required field NeverExpires *bool `type:"boolean" required:"true"` // contains filtered or unexported fields }
func (s ModifyBackupAttributesInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ModifyBackupAttributesInput) SetBackupId(v string) *ModifyBackupAttributesInput
SetBackupId sets the BackupId field's value.
func (s *ModifyBackupAttributesInput) SetNeverExpires(v bool) *ModifyBackupAttributesInput
SetNeverExpires sets the NeverExpires field's value.
func (s ModifyBackupAttributesInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ModifyBackupAttributesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ModifyBackupAttributesOutput struct { // Contains information about a backup of an CloudHSM cluster. All backup objects // contain the BackupId, BackupState, ClusterId, and CreateTimestamp parameters. // Backups that were copied into a destination region additionally contain the // CopyTimestamp, SourceBackup, SourceCluster, and SourceRegion parameters. // A backup that is pending deletion will include the DeleteTimestamp parameter. Backup *Backup `type:"structure"` // contains filtered or unexported fields }
func (s ModifyBackupAttributesOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ModifyBackupAttributesOutput) SetBackup(v *Backup) *ModifyBackupAttributesOutput
SetBackup sets the Backup field's value.
func (s ModifyBackupAttributesOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type ModifyClusterInput struct { // A policy that defines how the service retains backups. // // BackupRetentionPolicy is a required field BackupRetentionPolicy *BackupRetentionPolicy `type:"structure" required:"true"` // The identifier (ID) of the cluster that you want to modify. To find the cluster // ID, use DescribeClusters. // // ClusterId is a required field ClusterId *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s ModifyClusterInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ModifyClusterInput) SetBackupRetentionPolicy(v *BackupRetentionPolicy) *ModifyClusterInput
SetBackupRetentionPolicy sets the BackupRetentionPolicy field's value.
func (s *ModifyClusterInput) SetClusterId(v string) *ModifyClusterInput
SetClusterId sets the ClusterId field's value.
func (s ModifyClusterInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ModifyClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ModifyClusterOutput struct { // Contains information about an CloudHSM cluster. Cluster *Cluster `type:"structure"` // contains filtered or unexported fields }
func (s ModifyClusterOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *ModifyClusterOutput) SetCluster(v *Cluster) *ModifyClusterOutput
SetCluster sets the Cluster field's value.
func (s ModifyClusterOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type PutResourcePolicyInput struct { // The policy you want to associate with a resource. // // For an example policy, see Working with shared backups (https://docs.aws.amazon.com/cloudhsm/latest/userguide/sharing.html) // in the CloudHSM User Guide Policy *string `min:"1" type:"string"` // Amazon Resource Name (ARN) of the resource to which you want to attach a // policy. ResourceArn *string `type:"string"` // contains filtered or unexported fields }
func (s PutResourcePolicyInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutResourcePolicyInput) SetPolicy(v string) *PutResourcePolicyInput
SetPolicy sets the Policy field's value.
func (s *PutResourcePolicyInput) SetResourceArn(v string) *PutResourcePolicyInput
SetResourceArn sets the ResourceArn field's value.
func (s PutResourcePolicyInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutResourcePolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type PutResourcePolicyOutput struct { // The policy attached to a resource. Policy *string `min:"1" type:"string"` // Amazon Resource Name (ARN) of the resource to which a policy is attached. ResourceArn *string `type:"string"` // contains filtered or unexported fields }
func (s PutResourcePolicyOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *PutResourcePolicyOutput) SetPolicy(v string) *PutResourcePolicyOutput
SetPolicy sets the Policy field's value.
func (s *PutResourcePolicyOutput) SetResourceArn(v string) *PutResourcePolicyOutput
SetResourceArn sets the ResourceArn field's value.
func (s PutResourcePolicyOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type RestoreBackupInput struct { // The ID of the backup to be restored. To find the ID of a backup, use the // DescribeBackups operation. // // BackupId is a required field BackupId *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (s RestoreBackupInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RestoreBackupInput) SetBackupId(v string) *RestoreBackupInput
SetBackupId sets the BackupId field's value.
func (s RestoreBackupInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RestoreBackupInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RestoreBackupOutput struct { // Information on the Backup object created. Backup *Backup `type:"structure"` // contains filtered or unexported fields }
func (s RestoreBackupOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *RestoreBackupOutput) SetBackup(v *Backup) *RestoreBackupOutput
SetBackup sets the Backup field's value.
func (s RestoreBackupOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type Tag struct { // The key of the tag. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // The value of the tag. // // Value is a required field Value *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains a tag. A tag is a key-value pair.
func (s Tag) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Tag) SetKey(v string) *Tag
SetKey sets the Key field's value.
func (s *Tag) SetValue(v string) *Tag
SetValue sets the Value field's value.
func (s Tag) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *Tag) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceInput struct { // The cluster identifier (ID) for the cluster that you are tagging. To find // the cluster ID, use DescribeClusters. // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // A list of one or more tags. // // TagList is a required field TagList []*Tag `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (s TagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagResourceInput) SetResourceId(v string) *TagResourceInput
SetResourceId sets the ResourceId field's value.
func (s *TagResourceInput) SetTagList(v []*Tag) *TagResourceInput
SetTagList sets the TagList field's value.
func (s TagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (s TagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s TagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
type UntagResourceInput struct { // The cluster identifier (ID) for the cluster whose tags you are removing. // To find the cluster ID, use DescribeClusters. // // ResourceId is a required field ResourceId *string `type:"string" required:"true"` // A list of one or more tag keys for the tags that you are removing. Specify // only the tag keys, not the tag values. // // TagKeyList is a required field TagKeyList []*string `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
func (s UntagResourceInput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UntagResourceInput) SetResourceId(v string) *UntagResourceInput
SetResourceId sets the ResourceId field's value.
func (s *UntagResourceInput) SetTagKeyList(v []*string) *UntagResourceInput
SetTagKeyList sets the TagKeyList field's value.
func (s UntagResourceInput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (s UntagResourceOutput) GoString() string
GoString returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".
func (s UntagResourceOutput) String() string
String returns the string representation.
API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".