Documentation ¶
Overview ¶
Package cloudhsmv2 provides the client and types for making API requests to AWS CloudHSM V2.
For more information about AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) and the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/).
See https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28 for more information on this service.
See cloudhsmv2 package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudhsmv2/
Using the Client ¶
To contact AWS CloudHSM V2 with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS CloudHSM V2 client CloudHSMV2 for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudhsmv2/#New
Index ¶
- Constants
- type Backup
- type Certificates
- func (s Certificates) GoString() string
- func (s *Certificates) SetAwsHardwareCertificate(v string) *Certificates
- func (s *Certificates) SetClusterCertificate(v string) *Certificates
- func (s *Certificates) SetClusterCsr(v string) *Certificates
- func (s *Certificates) SetHsmCertificate(v string) *Certificates
- func (s *Certificates) SetManufacturerHardwareCertificate(v string) *Certificates
- func (s Certificates) String() string
- type CloudHSMV2
- func (c *CloudHSMV2) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)
- func (c *CloudHSMV2) CreateClusterRequest(input *CreateClusterInput) (req *request.Request, output *CreateClusterOutput)
- func (c *CloudHSMV2) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)
- func (c *CloudHSMV2) CreateHsm(input *CreateHsmInput) (*CreateHsmOutput, error)
- func (c *CloudHSMV2) CreateHsmRequest(input *CreateHsmInput) (req *request.Request, output *CreateHsmOutput)
- func (c *CloudHSMV2) CreateHsmWithContext(ctx aws.Context, input *CreateHsmInput, opts ...request.Option) (*CreateHsmOutput, error)
- func (c *CloudHSMV2) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)
- func (c *CloudHSMV2) DeleteClusterRequest(input *DeleteClusterInput) (req *request.Request, output *DeleteClusterOutput)
- func (c *CloudHSMV2) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)
- func (c *CloudHSMV2) DeleteHsm(input *DeleteHsmInput) (*DeleteHsmOutput, error)
- func (c *CloudHSMV2) DeleteHsmRequest(input *DeleteHsmInput) (req *request.Request, output *DeleteHsmOutput)
- func (c *CloudHSMV2) DeleteHsmWithContext(ctx aws.Context, input *DeleteHsmInput, opts ...request.Option) (*DeleteHsmOutput, error)
- func (c *CloudHSMV2) DescribeBackups(input *DescribeBackupsInput) (*DescribeBackupsOutput, error)
- func (c *CloudHSMV2) DescribeBackupsPages(input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool) error
- func (c *CloudHSMV2) DescribeBackupsPagesWithContext(ctx aws.Context, input *DescribeBackupsInput, ...) error
- func (c *CloudHSMV2) DescribeBackupsRequest(input *DescribeBackupsInput) (req *request.Request, output *DescribeBackupsOutput)
- func (c *CloudHSMV2) DescribeBackupsWithContext(ctx aws.Context, input *DescribeBackupsInput, opts ...request.Option) (*DescribeBackupsOutput, error)
- func (c *CloudHSMV2) DescribeClusters(input *DescribeClustersInput) (*DescribeClustersOutput, error)
- func (c *CloudHSMV2) DescribeClustersPages(input *DescribeClustersInput, fn func(*DescribeClustersOutput, bool) bool) error
- func (c *CloudHSMV2) DescribeClustersPagesWithContext(ctx aws.Context, input *DescribeClustersInput, ...) error
- func (c *CloudHSMV2) DescribeClustersRequest(input *DescribeClustersInput) (req *request.Request, output *DescribeClustersOutput)
- func (c *CloudHSMV2) DescribeClustersWithContext(ctx aws.Context, input *DescribeClustersInput, opts ...request.Option) (*DescribeClustersOutput, error)
- func (c *CloudHSMV2) InitializeCluster(input *InitializeClusterInput) (*InitializeClusterOutput, error)
- func (c *CloudHSMV2) InitializeClusterRequest(input *InitializeClusterInput) (req *request.Request, output *InitializeClusterOutput)
- func (c *CloudHSMV2) InitializeClusterWithContext(ctx aws.Context, input *InitializeClusterInput, opts ...request.Option) (*InitializeClusterOutput, error)
- func (c *CloudHSMV2) ListTags(input *ListTagsInput) (*ListTagsOutput, error)
- func (c *CloudHSMV2) ListTagsPages(input *ListTagsInput, fn func(*ListTagsOutput, bool) bool) error
- func (c *CloudHSMV2) ListTagsPagesWithContext(ctx aws.Context, input *ListTagsInput, fn func(*ListTagsOutput, bool) bool, ...) error
- func (c *CloudHSMV2) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)
- func (c *CloudHSMV2) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)
- func (c *CloudHSMV2) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
- func (c *CloudHSMV2) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
- func (c *CloudHSMV2) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
- func (c *CloudHSMV2) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
- func (c *CloudHSMV2) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
- func (c *CloudHSMV2) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
- type Cluster
- func (s Cluster) GoString() string
- func (s *Cluster) SetBackupPolicy(v string) *Cluster
- func (s *Cluster) SetCertificates(v *Certificates) *Cluster
- func (s *Cluster) SetClusterId(v string) *Cluster
- func (s *Cluster) SetCreateTimestamp(v time.Time) *Cluster
- func (s *Cluster) SetHsmType(v string) *Cluster
- func (s *Cluster) SetHsms(v []*Hsm) *Cluster
- func (s *Cluster) SetPreCoPassword(v string) *Cluster
- func (s *Cluster) SetSecurityGroup(v string) *Cluster
- func (s *Cluster) SetSourceBackupId(v string) *Cluster
- func (s *Cluster) SetState(v string) *Cluster
- func (s *Cluster) SetStateMessage(v string) *Cluster
- func (s *Cluster) SetSubnetMapping(v map[string]*string) *Cluster
- func (s *Cluster) SetVpcId(v string) *Cluster
- func (s Cluster) String() string
- type CreateClusterInput
- func (s CreateClusterInput) GoString() string
- func (s *CreateClusterInput) SetHsmType(v string) *CreateClusterInput
- func (s *CreateClusterInput) SetSourceBackupId(v string) *CreateClusterInput
- func (s *CreateClusterInput) SetSubnetIds(v []*string) *CreateClusterInput
- func (s CreateClusterInput) String() string
- func (s *CreateClusterInput) Validate() error
- type CreateClusterOutput
- type CreateHsmInput
- func (s CreateHsmInput) GoString() string
- func (s *CreateHsmInput) SetAvailabilityZone(v string) *CreateHsmInput
- func (s *CreateHsmInput) SetClusterId(v string) *CreateHsmInput
- func (s *CreateHsmInput) SetIpAddress(v string) *CreateHsmInput
- func (s CreateHsmInput) String() string
- func (s *CreateHsmInput) Validate() error
- type CreateHsmOutput
- type DeleteClusterInput
- type DeleteClusterOutput
- type DeleteHsmInput
- func (s DeleteHsmInput) GoString() string
- func (s *DeleteHsmInput) SetClusterId(v string) *DeleteHsmInput
- func (s *DeleteHsmInput) SetEniId(v string) *DeleteHsmInput
- func (s *DeleteHsmInput) SetEniIp(v string) *DeleteHsmInput
- func (s *DeleteHsmInput) SetHsmId(v string) *DeleteHsmInput
- func (s DeleteHsmInput) String() string
- func (s *DeleteHsmInput) Validate() error
- type DeleteHsmOutput
- type DescribeBackupsInput
- func (s DescribeBackupsInput) GoString() string
- func (s *DescribeBackupsInput) SetFilters(v map[string][]*string) *DescribeBackupsInput
- func (s *DescribeBackupsInput) SetMaxResults(v int64) *DescribeBackupsInput
- func (s *DescribeBackupsInput) SetNextToken(v string) *DescribeBackupsInput
- func (s DescribeBackupsInput) String() string
- func (s *DescribeBackupsInput) Validate() error
- type DescribeBackupsOutput
- type DescribeClustersInput
- func (s DescribeClustersInput) GoString() string
- func (s *DescribeClustersInput) SetFilters(v map[string][]*string) *DescribeClustersInput
- func (s *DescribeClustersInput) SetMaxResults(v int64) *DescribeClustersInput
- func (s *DescribeClustersInput) SetNextToken(v string) *DescribeClustersInput
- func (s DescribeClustersInput) String() string
- func (s *DescribeClustersInput) Validate() error
- type DescribeClustersOutput
- type Hsm
- func (s Hsm) GoString() string
- func (s *Hsm) SetAvailabilityZone(v string) *Hsm
- func (s *Hsm) SetClusterId(v string) *Hsm
- func (s *Hsm) SetEniId(v string) *Hsm
- func (s *Hsm) SetEniIp(v string) *Hsm
- func (s *Hsm) SetHsmId(v string) *Hsm
- func (s *Hsm) SetState(v string) *Hsm
- func (s *Hsm) SetStateMessage(v string) *Hsm
- func (s *Hsm) SetSubnetId(v string) *Hsm
- func (s Hsm) String() string
- type InitializeClusterInput
- func (s InitializeClusterInput) GoString() string
- func (s *InitializeClusterInput) SetClusterId(v string) *InitializeClusterInput
- func (s *InitializeClusterInput) SetSignedCert(v string) *InitializeClusterInput
- func (s *InitializeClusterInput) SetTrustAnchor(v string) *InitializeClusterInput
- func (s InitializeClusterInput) String() string
- func (s *InitializeClusterInput) Validate() error
- type InitializeClusterOutput
- type ListTagsInput
- func (s ListTagsInput) GoString() string
- func (s *ListTagsInput) SetMaxResults(v int64) *ListTagsInput
- func (s *ListTagsInput) SetNextToken(v string) *ListTagsInput
- func (s *ListTagsInput) SetResourceId(v string) *ListTagsInput
- func (s ListTagsInput) String() string
- func (s *ListTagsInput) Validate() error
- type ListTagsOutput
- type Tag
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
Constants ¶
const ( // BackupStateCreateInProgress is a BackupState enum value BackupStateCreateInProgress = "CREATE_IN_PROGRESS" // BackupStateReady is a BackupState enum value BackupStateReady = "READY" // BackupStateDeleted is a BackupState enum value BackupStateDeleted = "DELETED" )
const ( // ClusterStateCreateInProgress is a ClusterState enum value ClusterStateCreateInProgress = "CREATE_IN_PROGRESS" // ClusterStateUninitialized is a ClusterState enum value ClusterStateUninitialized = "UNINITIALIZED" // ClusterStateInitializeInProgress is a ClusterState enum value ClusterStateInitializeInProgress = "INITIALIZE_IN_PROGRESS" // ClusterStateInitialized is a ClusterState enum value ClusterStateInitialized = "INITIALIZED" // ClusterStateActive is a ClusterState enum value ClusterStateActive = "ACTIVE" // ClusterStateUpdateInProgress is a ClusterState enum value ClusterStateUpdateInProgress = "UPDATE_IN_PROGRESS" // ClusterStateDeleteInProgress is a ClusterState enum value ClusterStateDeleteInProgress = "DELETE_IN_PROGRESS" // ClusterStateDeleted is a ClusterState enum value ClusterStateDeleted = "DELETED" // ClusterStateDegraded is a ClusterState enum value ClusterStateDegraded = "DEGRADED" )
const ( // HsmStateCreateInProgress is a HsmState enum value HsmStateCreateInProgress = "CREATE_IN_PROGRESS" // HsmStateActive is a HsmState enum value HsmStateActive = "ACTIVE" // HsmStateDegraded is a HsmState enum value HsmStateDegraded = "DEGRADED" // HsmStateDeleteInProgress is a HsmState enum value HsmStateDeleteInProgress = "DELETE_IN_PROGRESS" // HsmStateDeleted is a HsmState enum value HsmStateDeleted = "DELETED" )
const ( // ErrCodeCloudHsmAccessDeniedException for service response error code // "CloudHsmAccessDeniedException". // // The request was rejected because the requester does not have permission to // perform the requested operation. ErrCodeCloudHsmAccessDeniedException = "CloudHsmAccessDeniedException" // ErrCodeCloudHsmInternalFailureException for service response error code // "CloudHsmInternalFailureException". // // The request was rejected because of an AWS CloudHSM internal failure. The // request can be retried. ErrCodeCloudHsmInternalFailureException = "CloudHsmInternalFailureException" // ErrCodeCloudHsmInvalidRequestException for service response error code // "CloudHsmInvalidRequestException". // // The request was rejected because it is not a valid request. ErrCodeCloudHsmInvalidRequestException = "CloudHsmInvalidRequestException" // ErrCodeCloudHsmResourceNotFoundException for service response error code // "CloudHsmResourceNotFoundException". // // The request was rejected because it refers to a resource that cannot be found. ErrCodeCloudHsmResourceNotFoundException = "CloudHsmResourceNotFoundException" // ErrCodeCloudHsmServiceException for service response error code // "CloudHsmServiceException". // // The request was rejected because an error occurred. ErrCodeCloudHsmServiceException = "CloudHsmServiceException" )
const ( ServiceName = "cloudhsmv2" // Service endpoint prefix API calls made to. EndpointsID = ServiceName // Service ID for Regions and Endpoints metadata. )
Service information constants
const (
// BackupPolicyDefault is a BackupPolicy enum value
BackupPolicyDefault = "DEFAULT"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Backup ¶
type Backup struct { // The identifier (ID) of the backup. // // BackupId is a required field BackupId *string `type:"string" required:"true"` // The state of the backup. BackupState *string `type:"string" enum:"BackupState"` // The identifier (ID) of the cluster that was backed up. ClusterId *string `type:"string"` // The date and time when the backup was created. CreateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"` // contains filtered or unexported fields }
Contains information about a backup of an AWS CloudHSM cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Backup
func (*Backup) SetBackupId ¶
SetBackupId sets the BackupId field's value.
func (*Backup) SetBackupState ¶
SetBackupState sets the BackupState field's value.
func (*Backup) SetClusterId ¶
SetClusterId sets the ClusterId field's value.
func (*Backup) SetCreateTimestamp ¶
SetCreateTimestamp sets the CreateTimestamp field's value.
type Certificates ¶
type Certificates struct { // The HSM hardware certificate issued (signed) by AWS CloudHSM. AwsHardwareCertificate *string `type:"string"` // The cluster certificate issued (signed) by the issuing certificate authority // (CA) of the cluster's owner. ClusterCertificate *string `type:"string"` // The cluster's certificate signing request (CSR). The CSR exists only when // the cluster's state is UNINITIALIZED. ClusterCsr *string `type:"string"` // The HSM certificate issued (signed) by the HSM hardware. HsmCertificate *string `type:"string"` // The HSM hardware certificate issued (signed) by the hardware manufacturer. ManufacturerHardwareCertificate *string `type:"string"` // contains filtered or unexported fields }
Contains one or more certificates or a certificate signing request (CSR). Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Certificates
func (Certificates) GoString ¶
func (s Certificates) GoString() string
GoString returns the string representation
func (*Certificates) SetAwsHardwareCertificate ¶
func (s *Certificates) SetAwsHardwareCertificate(v string) *Certificates
SetAwsHardwareCertificate sets the AwsHardwareCertificate field's value.
func (*Certificates) SetClusterCertificate ¶
func (s *Certificates) SetClusterCertificate(v string) *Certificates
SetClusterCertificate sets the ClusterCertificate field's value.
func (*Certificates) SetClusterCsr ¶
func (s *Certificates) SetClusterCsr(v string) *Certificates
SetClusterCsr sets the ClusterCsr field's value.
func (*Certificates) SetHsmCertificate ¶
func (s *Certificates) SetHsmCertificate(v string) *Certificates
SetHsmCertificate sets the HsmCertificate field's value.
func (*Certificates) SetManufacturerHardwareCertificate ¶
func (s *Certificates) SetManufacturerHardwareCertificate(v string) *Certificates
SetManufacturerHardwareCertificate sets the ManufacturerHardwareCertificate field's value.
func (Certificates) String ¶
func (s Certificates) String() string
String returns the string representation
type CloudHSMV2 ¶
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 ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudHSMV2
New creates a new instance of the CloudHSMV2 client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a CloudHSMV2 client from just a session. svc := cloudhsmv2.New(mySession) // Create a CloudHSMV2 client with additional configuration svc := cloudhsmv2.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*CloudHSMV2) CreateCluster ¶
func (c *CloudHSMV2) CreateCluster(input *CreateClusterInput) (*CreateClusterOutput, error)
CreateCluster API operation for AWS CloudHSM V2.
Creates a new AWS CloudHSM cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation CreateCluster for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException" The request was rejected because it refers to a resource that cannot be found.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateCluster
func (*CloudHSMV2) CreateClusterRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See 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) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateCluster
func (*CloudHSMV2) CreateClusterWithContext ¶
func (c *CloudHSMV2) CreateClusterWithContext(ctx aws.Context, input *CreateClusterInput, opts ...request.Option) (*CreateClusterOutput, error)
CreateClusterWithContext is the same as CreateCluster with the addition of the ability to pass a context and additional request options.
See CreateCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) CreateHsm ¶
func (c *CloudHSMV2) CreateHsm(input *CreateHsmInput) (*CreateHsmOutput, error)
CreateHsm API operation for AWS CloudHSM V2.
Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation CreateHsm for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException" The request was rejected because it refers to a resource that cannot be found.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsm
func (*CloudHSMV2) CreateHsmRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateHsm for more information on using the CreateHsm API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateHsmRequest method. req, resp := client.CreateHsmRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsm
func (*CloudHSMV2) CreateHsmWithContext ¶
func (c *CloudHSMV2) CreateHsmWithContext(ctx aws.Context, input *CreateHsmInput, opts ...request.Option) (*CreateHsmOutput, error)
CreateHsmWithContext is the same as CreateHsm with the addition of the ability to pass a context and additional request options.
See CreateHsm for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) DeleteCluster ¶
func (c *CloudHSMV2) DeleteCluster(input *DeleteClusterInput) (*DeleteClusterOutput, error)
DeleteCluster API operation for AWS CloudHSM V2.
Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DeleteCluster for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException" The request was rejected because it refers to a resource that cannot be found.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteCluster
func (*CloudHSMV2) DeleteClusterRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See 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) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteCluster
func (*CloudHSMV2) DeleteClusterWithContext ¶
func (c *CloudHSMV2) DeleteClusterWithContext(ctx aws.Context, input *DeleteClusterInput, opts ...request.Option) (*DeleteClusterOutput, error)
DeleteClusterWithContext is the same as DeleteCluster with the addition of the ability to pass a context and additional request options.
See DeleteCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) DeleteHsm ¶
func (c *CloudHSMV2) DeleteHsm(input *DeleteHsmInput) (*DeleteHsmOutput, error)
DeleteHsm API operation for AWS CloudHSM V2.
Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DeleteHsm for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException" The request was rejected because it refers to a resource that cannot be found.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsm
func (*CloudHSMV2) DeleteHsmRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteHsm for more information on using the DeleteHsm API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteHsmRequest method. req, resp := client.DeleteHsmRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsm
func (*CloudHSMV2) DeleteHsmWithContext ¶
func (c *CloudHSMV2) DeleteHsmWithContext(ctx aws.Context, input *DeleteHsmInput, opts ...request.Option) (*DeleteHsmOutput, error)
DeleteHsmWithContext is the same as DeleteHsm with the addition of the ability to pass a context and additional request options.
See DeleteHsm for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) DescribeBackups ¶
func (c *CloudHSMV2) DescribeBackups(input *DescribeBackupsInput) (*DescribeBackupsOutput, error)
DescribeBackups API operation for AWS CloudHSM V2.
Gets information about backups of AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DescribeBackups for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException" The request was rejected because it refers to a resource that cannot be found.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackups
func (*CloudHSMV2) DescribeBackupsPages ¶
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 *DescribeBackupsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudHSMV2) DescribeBackupsPagesWithContext ¶
func (c *CloudHSMV2) DescribeBackupsPagesWithContext(ctx aws.Context, input *DescribeBackupsInput, fn func(*DescribeBackupsOutput, bool) bool, opts ...request.Option) error
DescribeBackupsPagesWithContext same as DescribeBackupsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) DescribeBackupsRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See 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) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackups
func (*CloudHSMV2) DescribeBackupsWithContext ¶
func (c *CloudHSMV2) DescribeBackupsWithContext(ctx aws.Context, input *DescribeBackupsInput, opts ...request.Option) (*DescribeBackupsOutput, error)
DescribeBackupsWithContext is the same as DescribeBackups with the addition of the ability to pass a context and additional request options.
See DescribeBackups for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) DescribeClusters ¶
func (c *CloudHSMV2) DescribeClusters(input *DescribeClustersInput) (*DescribeClustersOutput, error)
DescribeClusters API operation for AWS CloudHSM V2.
Gets information about AWS CloudHSM clusters.
This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation DescribeClusters for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClusters
func (*CloudHSMV2) DescribeClustersPages ¶
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 *DescribeClustersOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudHSMV2) DescribeClustersPagesWithContext ¶
func (c *CloudHSMV2) DescribeClustersPagesWithContext(ctx aws.Context, input *DescribeClustersInput, fn func(*DescribeClustersOutput, bool) bool, opts ...request.Option) error
DescribeClustersPagesWithContext same as DescribeClustersPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) DescribeClustersRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See 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) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClusters
func (*CloudHSMV2) DescribeClustersWithContext ¶
func (c *CloudHSMV2) DescribeClustersWithContext(ctx aws.Context, input *DescribeClustersInput, opts ...request.Option) (*DescribeClustersOutput, error)
DescribeClustersWithContext is the same as DescribeClusters with the addition of the ability to pass a context and additional request options.
See DescribeClusters for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) InitializeCluster ¶
func (c *CloudHSMV2) InitializeCluster(input *InitializeClusterInput) (*InitializeClusterOutput, error)
InitializeCluster API operation for AWS CloudHSM V2.
Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation InitializeCluster for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException" The request was rejected because it refers to a resource that cannot be found.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeCluster
func (*CloudHSMV2) InitializeClusterRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See 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) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeCluster
func (*CloudHSMV2) InitializeClusterWithContext ¶
func (c *CloudHSMV2) InitializeClusterWithContext(ctx aws.Context, input *InitializeClusterInput, opts ...request.Option) (*InitializeClusterOutput, error)
InitializeClusterWithContext is the same as InitializeCluster with the addition of the ability to pass a context and additional request options.
See InitializeCluster for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) ListTags ¶
func (c *CloudHSMV2) ListTags(input *ListTagsInput) (*ListTagsOutput, error)
ListTags API operation for AWS CloudHSM V2.
Gets a list of tags for the specified AWS CloudHSM cluster.
This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation ListTags for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException" The request was rejected because it refers to a resource that cannot be found.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTags
func (*CloudHSMV2) ListTagsPages ¶
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 *ListTagsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*CloudHSMV2) ListTagsPagesWithContext ¶
func (c *CloudHSMV2) ListTagsPagesWithContext(ctx aws.Context, input *ListTagsInput, fn func(*ListTagsOutput, bool) bool, opts ...request.Option) error
ListTagsPagesWithContext same as ListTagsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) ListTagsRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See 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) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTags
func (*CloudHSMV2) ListTagsWithContext ¶
func (c *CloudHSMV2) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)
ListTagsWithContext is the same as ListTags with the addition of the ability to pass a context and additional request options.
See ListTags for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) TagResource ¶
func (c *CloudHSMV2) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for AWS CloudHSM V2.
Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation TagResource for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException" The request was rejected because it refers to a resource that cannot be found.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResource
func (*CloudHSMV2) TagResourceRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See 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) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResource
func (*CloudHSMV2) TagResourceWithContext ¶
func (c *CloudHSMV2) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.
See TagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*CloudHSMV2) UntagResource ¶
func (c *CloudHSMV2) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for AWS CloudHSM V2.
Removes the specified tag or tags from the specified AWS CloudHSM cluster.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS CloudHSM V2's API operation UntagResource for usage and error information.
Returned Error Codes:
ErrCodeCloudHsmInternalFailureException "CloudHsmInternalFailureException" The request was rejected because of an AWS CloudHSM internal failure. The request can be retried.
ErrCodeCloudHsmServiceException "CloudHsmServiceException" The request was rejected because an error occurred.
ErrCodeCloudHsmResourceNotFoundException "CloudHsmResourceNotFoundException" The request was rejected because it refers to a resource that cannot be found.
ErrCodeCloudHsmInvalidRequestException "CloudHsmInvalidRequestException" The request was rejected because it is not a valid request.
ErrCodeCloudHsmAccessDeniedException "CloudHsmAccessDeniedException" The request was rejected because the requester does not have permission to perform the requested operation.
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResource
func (*CloudHSMV2) UntagResourceRequest ¶
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 complets successfuly.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See 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) }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResource
func (*CloudHSMV2) UntagResourceWithContext ¶
func (c *CloudHSMV2) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.
See UntagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type Cluster ¶
type Cluster struct { // The cluster's backup policy. BackupPolicy *string `type:"string" enum:"BackupPolicy"` // Contains one or more certificates or a certificate signing request (CSR). Certificates *Certificates `type:"structure"` // The cluster's identifier (ID). ClusterId *string `type:"string"` // The date and time when the cluster was created. CreateTimestamp *time.Time `type:"timestamp" timestampFormat:"unix"` // The type of HSM that the cluster contains. HsmType *string `type:"string"` // Contains information about the HSMs in the cluster. Hsms []*Hsm `type:"list"` // The default password for the cluster's Pre-Crypto Officer (PRECO) user. PreCoPassword *string `min:"7" type:"string"` // The identifier (ID) of the cluster's security group. SecurityGroup *string `type:"string"` // The identifier (ID) of the backup used to create the cluster. This value // exists only when the cluster was created from a backup. SourceBackupId *string `type:"string"` // The cluster's state. State *string `type:"string" enum:"ClusterState"` // A description of the cluster's state. StateMessage *string `type:"string"` // A map of the cluster's subnets and their corresponding Availability Zones. SubnetMapping map[string]*string `type:"map"` // The identifier (ID) of the virtual private cloud (VPC) that contains the // cluster. VpcId *string `type:"string"` // contains filtered or unexported fields }
Contains information about an AWS CloudHSM cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Cluster
func (*Cluster) SetBackupPolicy ¶
SetBackupPolicy sets the BackupPolicy field's value.
func (*Cluster) SetCertificates ¶
func (s *Cluster) SetCertificates(v *Certificates) *Cluster
SetCertificates sets the Certificates field's value.
func (*Cluster) SetClusterId ¶
SetClusterId sets the ClusterId field's value.
func (*Cluster) SetCreateTimestamp ¶
SetCreateTimestamp sets the CreateTimestamp field's value.
func (*Cluster) SetHsmType ¶
SetHsmType sets the HsmType field's value.
func (*Cluster) SetPreCoPassword ¶
SetPreCoPassword sets the PreCoPassword field's value.
func (*Cluster) SetSecurityGroup ¶
SetSecurityGroup sets the SecurityGroup field's value.
func (*Cluster) SetSourceBackupId ¶
SetSourceBackupId sets the SourceBackupId field's value.
func (*Cluster) SetStateMessage ¶
SetStateMessage sets the StateMessage field's value.
func (*Cluster) SetSubnetMapping ¶
SetSubnetMapping sets the SubnetMapping field's value.
type CreateClusterInput ¶
type CreateClusterInput struct { // The type of HSM to use in the cluster. Currently the only allowed value is // hsm1.medium. // // HsmType is a required field HsmType *string `type:"string" required:"true"` // The identifier (ID) of the cluster backup to restore. Use this value to restore // the cluster from a backup instead of creating a new cluster. To find the // backup ID, use DescribeBackups. SourceBackupId *string `type:"string"` // The identifiers (IDs) of the subnets where you are creating the cluster. // You must specify at least one subnet. If you specify multiple subnets, they // must meet the following criteria: // // * All subnets must be in the same virtual private cloud (VPC). // // * You can specify only one subnet per Availability Zone. // // SubnetIds is a required field SubnetIds []*string `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateClusterRequest
func (CreateClusterInput) GoString ¶
func (s CreateClusterInput) GoString() string
GoString returns the string representation
func (*CreateClusterInput) SetHsmType ¶
func (s *CreateClusterInput) SetHsmType(v string) *CreateClusterInput
SetHsmType sets the HsmType field's value.
func (*CreateClusterInput) SetSourceBackupId ¶
func (s *CreateClusterInput) SetSourceBackupId(v string) *CreateClusterInput
SetSourceBackupId sets the SourceBackupId field's value.
func (*CreateClusterInput) SetSubnetIds ¶
func (s *CreateClusterInput) SetSubnetIds(v []*string) *CreateClusterInput
SetSubnetIds sets the SubnetIds field's value.
func (CreateClusterInput) String ¶
func (s CreateClusterInput) String() string
String returns the string representation
func (*CreateClusterInput) Validate ¶
func (s *CreateClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateClusterOutput ¶
type CreateClusterOutput struct { // Information about the cluster that was created. Cluster *Cluster `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateClusterResponse
func (CreateClusterOutput) GoString ¶
func (s CreateClusterOutput) GoString() string
GoString returns the string representation
func (*CreateClusterOutput) SetCluster ¶
func (s *CreateClusterOutput) SetCluster(v *Cluster) *CreateClusterOutput
SetCluster sets the Cluster field's value.
func (CreateClusterOutput) String ¶
func (s CreateClusterOutput) String() string
String returns the string representation
type CreateHsmInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsmRequest
func (CreateHsmInput) GoString ¶
func (s CreateHsmInput) GoString() string
GoString returns the string representation
func (*CreateHsmInput) SetAvailabilityZone ¶
func (s *CreateHsmInput) SetAvailabilityZone(v string) *CreateHsmInput
SetAvailabilityZone sets the AvailabilityZone field's value.
func (*CreateHsmInput) SetClusterId ¶
func (s *CreateHsmInput) SetClusterId(v string) *CreateHsmInput
SetClusterId sets the ClusterId field's value.
func (*CreateHsmInput) SetIpAddress ¶
func (s *CreateHsmInput) SetIpAddress(v string) *CreateHsmInput
SetIpAddress sets the IpAddress field's value.
func (CreateHsmInput) String ¶
func (s CreateHsmInput) String() string
String returns the string representation
func (*CreateHsmInput) Validate ¶
func (s *CreateHsmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateHsmOutput ¶
type CreateHsmOutput struct { // Information about the HSM that was created. Hsm *Hsm `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsmResponse
func (CreateHsmOutput) GoString ¶
func (s CreateHsmOutput) GoString() string
GoString returns the string representation
func (*CreateHsmOutput) SetHsm ¶
func (s *CreateHsmOutput) SetHsm(v *Hsm) *CreateHsmOutput
SetHsm sets the Hsm field's value.
func (CreateHsmOutput) String ¶
func (s CreateHsmOutput) String() string
String returns the string representation
type DeleteClusterInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteClusterRequest
func (DeleteClusterInput) GoString ¶
func (s DeleteClusterInput) GoString() string
GoString returns the string representation
func (*DeleteClusterInput) SetClusterId ¶
func (s *DeleteClusterInput) SetClusterId(v string) *DeleteClusterInput
SetClusterId sets the ClusterId field's value.
func (DeleteClusterInput) String ¶
func (s DeleteClusterInput) String() string
String returns the string representation
func (*DeleteClusterInput) Validate ¶
func (s *DeleteClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteClusterOutput ¶
type DeleteClusterOutput struct { // Information about the cluster that was deleted. Cluster *Cluster `type:"structure"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteClusterResponse
func (DeleteClusterOutput) GoString ¶
func (s DeleteClusterOutput) GoString() string
GoString returns the string representation
func (*DeleteClusterOutput) SetCluster ¶
func (s *DeleteClusterOutput) SetCluster(v *Cluster) *DeleteClusterOutput
SetCluster sets the Cluster field's value.
func (DeleteClusterOutput) String ¶
func (s DeleteClusterOutput) String() string
String returns the string representation
type DeleteHsmInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsmRequest
func (DeleteHsmInput) GoString ¶
func (s DeleteHsmInput) GoString() string
GoString returns the string representation
func (*DeleteHsmInput) SetClusterId ¶
func (s *DeleteHsmInput) SetClusterId(v string) *DeleteHsmInput
SetClusterId sets the ClusterId field's value.
func (*DeleteHsmInput) SetEniId ¶
func (s *DeleteHsmInput) SetEniId(v string) *DeleteHsmInput
SetEniId sets the EniId field's value.
func (*DeleteHsmInput) SetEniIp ¶
func (s *DeleteHsmInput) SetEniIp(v string) *DeleteHsmInput
SetEniIp sets the EniIp field's value.
func (*DeleteHsmInput) SetHsmId ¶
func (s *DeleteHsmInput) SetHsmId(v string) *DeleteHsmInput
SetHsmId sets the HsmId field's value.
func (DeleteHsmInput) String ¶
func (s DeleteHsmInput) String() string
String returns the string representation
func (*DeleteHsmInput) Validate ¶
func (s *DeleteHsmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteHsmOutput ¶
type DeleteHsmOutput struct { // The identifier (ID) of the HSM that was deleted. HsmId *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsmResponse
func (DeleteHsmOutput) GoString ¶
func (s DeleteHsmOutput) GoString() string
GoString returns the string representation
func (*DeleteHsmOutput) SetHsmId ¶
func (s *DeleteHsmOutput) SetHsmId(v string) *DeleteHsmOutput
SetHsmId sets the HsmId field's value.
func (DeleteHsmOutput) String ¶
func (s DeleteHsmOutput) String() string
String returns the string representation
type DescribeBackupsInput ¶
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 clusterIds filter to return only the backups for the specified clusters. // Specify clusters by their cluster identifier (ID). // // Use the states filter to return only backups that match the specified state. Filters map[string][]*string `type:"map"` // The maximum number of backups to return in the response. When there are more // backups than the number you specify, the response contains a NextToken value. MaxResults *int64 `min:"1" type:"integer"` // The NextToken value that you received in the previous response. Use this // value to get more backups. NextToken *string `type:"string"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackupsRequest
func (DescribeBackupsInput) GoString ¶
func (s DescribeBackupsInput) GoString() string
GoString returns the string representation
func (*DescribeBackupsInput) SetFilters ¶
func (s *DescribeBackupsInput) SetFilters(v map[string][]*string) *DescribeBackupsInput
SetFilters sets the Filters field's value.
func (*DescribeBackupsInput) SetMaxResults ¶
func (s *DescribeBackupsInput) SetMaxResults(v int64) *DescribeBackupsInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeBackupsInput) SetNextToken ¶
func (s *DescribeBackupsInput) SetNextToken(v string) *DescribeBackupsInput
SetNextToken sets the NextToken field's value.
func (DescribeBackupsInput) String ¶
func (s DescribeBackupsInput) String() string
String returns the string representation
func (*DescribeBackupsInput) Validate ¶
func (s *DescribeBackupsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeBackupsOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackupsResponse
func (DescribeBackupsOutput) GoString ¶
func (s DescribeBackupsOutput) GoString() string
GoString returns the string representation
func (*DescribeBackupsOutput) SetBackups ¶
func (s *DescribeBackupsOutput) SetBackups(v []*Backup) *DescribeBackupsOutput
SetBackups sets the Backups field's value.
func (*DescribeBackupsOutput) SetNextToken ¶
func (s *DescribeBackupsOutput) SetNextToken(v string) *DescribeBackupsOutput
SetNextToken sets the NextToken field's value.
func (DescribeBackupsOutput) String ¶
func (s DescribeBackupsOutput) String() string
String returns the string representation
type DescribeClustersInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClustersRequest
func (DescribeClustersInput) GoString ¶
func (s DescribeClustersInput) GoString() string
GoString returns the string representation
func (*DescribeClustersInput) SetFilters ¶
func (s *DescribeClustersInput) SetFilters(v map[string][]*string) *DescribeClustersInput
SetFilters sets the Filters field's value.
func (*DescribeClustersInput) SetMaxResults ¶
func (s *DescribeClustersInput) SetMaxResults(v int64) *DescribeClustersInput
SetMaxResults sets the MaxResults field's value.
func (*DescribeClustersInput) SetNextToken ¶
func (s *DescribeClustersInput) SetNextToken(v string) *DescribeClustersInput
SetNextToken sets the NextToken field's value.
func (DescribeClustersInput) String ¶
func (s DescribeClustersInput) String() string
String returns the string representation
func (*DescribeClustersInput) Validate ¶
func (s *DescribeClustersInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeClustersOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClustersResponse
func (DescribeClustersOutput) GoString ¶
func (s DescribeClustersOutput) GoString() string
GoString returns the string representation
func (*DescribeClustersOutput) SetClusters ¶
func (s *DescribeClustersOutput) SetClusters(v []*Cluster) *DescribeClustersOutput
SetClusters sets the Clusters field's value.
func (*DescribeClustersOutput) SetNextToken ¶
func (s *DescribeClustersOutput) SetNextToken(v string) *DescribeClustersOutput
SetNextToken sets the NextToken field's value.
func (DescribeClustersOutput) String ¶
func (s DescribeClustersOutput) String() string
String returns the string representation
type Hsm ¶
type Hsm struct { // The Availability Zone that contains the HSM. AvailabilityZone *string `type:"string"` // The identifier (ID) of the cluster that contains the HSM. ClusterId *string `type:"string"` // The identifier (ID) of the HSM's elastic network interface (ENI). EniId *string `type:"string"` // The IP address of the HSM's elastic network interface (ENI). EniIp *string `type:"string"` // The HSM's identifier (ID). // // HsmId is a required field HsmId *string `type:"string" required:"true"` // The HSM's state. State *string `type:"string" enum:"HsmState"` // A description of the HSM's state. StateMessage *string `type:"string"` // The subnet that contains the HSM's elastic network interface (ENI). SubnetId *string `type:"string"` // contains filtered or unexported fields }
Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Hsm
func (*Hsm) SetAvailabilityZone ¶
SetAvailabilityZone sets the AvailabilityZone field's value.
func (*Hsm) SetClusterId ¶
SetClusterId sets the ClusterId field's value.
func (*Hsm) SetStateMessage ¶
SetStateMessage sets the StateMessage field's value.
func (*Hsm) SetSubnetId ¶
SetSubnetId sets the SubnetId field's value.
type InitializeClusterInput ¶
type InitializeClusterInput struct { // The identifier (ID) of the cluster that you are claiming. To find the cluster // ID, use DescribeClusters. // // ClusterId is a required field ClusterId *string `type:"string" required:"true"` // The cluster certificate issued (signed) by your issuing certificate authority // (CA). The certificate must be in PEM format and can contain a maximum of // 5000 characters. // // SignedCert is a required field SignedCert *string `type:"string" required:"true"` // The issuing certificate of the issuing certificate authority (CA) that issued // (signed) the cluster certificate. This can be a root (self-signed) certificate // or a certificate chain that begins with the certificate that issued the cluster // certificate and ends with a root certificate. The certificate or certificate // chain must be in PEM format and can contain a maximum of 5000 characters. // // TrustAnchor is a required field TrustAnchor *string `type:"string" required:"true"` // contains filtered or unexported fields }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeClusterRequest
func (InitializeClusterInput) GoString ¶
func (s InitializeClusterInput) GoString() string
GoString returns the string representation
func (*InitializeClusterInput) SetClusterId ¶
func (s *InitializeClusterInput) SetClusterId(v string) *InitializeClusterInput
SetClusterId sets the ClusterId field's value.
func (*InitializeClusterInput) SetSignedCert ¶
func (s *InitializeClusterInput) SetSignedCert(v string) *InitializeClusterInput
SetSignedCert sets the SignedCert field's value.
func (*InitializeClusterInput) SetTrustAnchor ¶
func (s *InitializeClusterInput) SetTrustAnchor(v string) *InitializeClusterInput
SetTrustAnchor sets the TrustAnchor field's value.
func (InitializeClusterInput) String ¶
func (s InitializeClusterInput) String() string
String returns the string representation
func (*InitializeClusterInput) Validate ¶
func (s *InitializeClusterInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type InitializeClusterOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeClusterResponse
func (InitializeClusterOutput) GoString ¶
func (s InitializeClusterOutput) GoString() string
GoString returns the string representation
func (*InitializeClusterOutput) SetState ¶
func (s *InitializeClusterOutput) SetState(v string) *InitializeClusterOutput
SetState sets the State field's value.
func (*InitializeClusterOutput) SetStateMessage ¶
func (s *InitializeClusterOutput) SetStateMessage(v string) *InitializeClusterOutput
SetStateMessage sets the StateMessage field's value.
func (InitializeClusterOutput) String ¶
func (s InitializeClusterOutput) String() string
String returns the string representation
type ListTagsInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTagsRequest
func (ListTagsInput) GoString ¶
func (s ListTagsInput) GoString() string
GoString returns the string representation
func (*ListTagsInput) SetMaxResults ¶
func (s *ListTagsInput) SetMaxResults(v int64) *ListTagsInput
SetMaxResults sets the MaxResults field's value.
func (*ListTagsInput) SetNextToken ¶
func (s *ListTagsInput) SetNextToken(v string) *ListTagsInput
SetNextToken sets the NextToken field's value.
func (*ListTagsInput) SetResourceId ¶
func (s *ListTagsInput) SetResourceId(v string) *ListTagsInput
SetResourceId sets the ResourceId field's value.
func (ListTagsInput) String ¶
func (s ListTagsInput) String() string
String returns the string representation
func (*ListTagsInput) Validate ¶
func (s *ListTagsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsOutput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTagsResponse
func (ListTagsOutput) GoString ¶
func (s ListTagsOutput) GoString() string
GoString returns the string representation
func (*ListTagsOutput) SetNextToken ¶
func (s *ListTagsOutput) SetNextToken(v string) *ListTagsOutput
SetNextToken sets the NextToken field's value.
func (*ListTagsOutput) SetTagList ¶
func (s *ListTagsOutput) SetTagList(v []*Tag) *ListTagsOutput
SetTagList sets the TagList field's value.
func (ListTagsOutput) String ¶
func (s ListTagsOutput) String() string
String returns the string representation
type Tag ¶
type Tag struct { // The key of the tag. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // The value of the tag. // // Value is a required field Value *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains a tag. A tag is a key-value pair. Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/Tag
type TagResourceInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResourceRequest
func (TagResourceInput) GoString ¶
func (s TagResourceInput) GoString() string
GoString returns the string representation
func (*TagResourceInput) SetResourceId ¶
func (s *TagResourceInput) SetResourceId(v string) *TagResourceInput
SetResourceId sets the ResourceId field's value.
func (*TagResourceInput) SetTagList ¶
func (s *TagResourceInput) SetTagList(v []*Tag) *TagResourceInput
SetTagList sets the TagList field's value.
func (TagResourceInput) String ¶
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶
type TagResourceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResourceResponse
func (TagResourceOutput) GoString ¶
func (s TagResourceOutput) GoString() string
GoString returns the string representation
func (TagResourceOutput) String ¶
func (s TagResourceOutput) String() string
String returns the string representation
type UntagResourceInput ¶
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 }
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResourceRequest
func (UntagResourceInput) GoString ¶
func (s UntagResourceInput) GoString() string
GoString returns the string representation
func (*UntagResourceInput) SetResourceId ¶
func (s *UntagResourceInput) SetResourceId(v string) *UntagResourceInput
SetResourceId sets the ResourceId field's value.
func (*UntagResourceInput) SetTagKeyList ¶
func (s *UntagResourceInput) SetTagKeyList(v []*string) *UntagResourceInput
SetTagKeyList sets the TagKeyList field's value.
func (UntagResourceInput) String ¶
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResourceResponse
func (UntagResourceOutput) GoString ¶
func (s UntagResourceOutput) GoString() string
GoString returns the string representation
func (UntagResourceOutput) String ¶
func (s UntagResourceOutput) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package cloudhsmv2iface provides an interface to enable mocking the AWS CloudHSM V2 service client for testing your code.
|
Package cloudhsmv2iface provides an interface to enable mocking the AWS CloudHSM V2 service client for testing your code. |