Documentation
¶
Overview ¶
Package cloudhsm provides a client for Amazon CloudHSM.
Index ¶
- Constants
- type AddTagsToResourceInput
- type AddTagsToResourceOutput
- type CloudHSM
- func (c *CloudHSM) AddTagsToResource(input *AddTagsToResourceInput) (*AddTagsToResourceOutput, error)
- func (c *CloudHSM) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *AddTagsToResourceOutput)
- func (c *CloudHSM) CreateHapg(input *CreateHapgInput) (*CreateHapgOutput, error)
- func (c *CloudHSM) CreateHapgRequest(input *CreateHapgInput) (req *request.Request, output *CreateHapgOutput)
- func (c *CloudHSM) CreateHsm(input *CreateHsmInput) (*CreateHsmOutput, error)
- func (c *CloudHSM) CreateHsmRequest(input *CreateHsmInput) (req *request.Request, output *CreateHsmOutput)
- func (c *CloudHSM) CreateLunaClient(input *CreateLunaClientInput) (*CreateLunaClientOutput, error)
- func (c *CloudHSM) CreateLunaClientRequest(input *CreateLunaClientInput) (req *request.Request, output *CreateLunaClientOutput)
- func (c *CloudHSM) DeleteHapg(input *DeleteHapgInput) (*DeleteHapgOutput, error)
- func (c *CloudHSM) DeleteHapgRequest(input *DeleteHapgInput) (req *request.Request, output *DeleteHapgOutput)
- func (c *CloudHSM) DeleteHsm(input *DeleteHsmInput) (*DeleteHsmOutput, error)
- func (c *CloudHSM) DeleteHsmRequest(input *DeleteHsmInput) (req *request.Request, output *DeleteHsmOutput)
- func (c *CloudHSM) DeleteLunaClient(input *DeleteLunaClientInput) (*DeleteLunaClientOutput, error)
- func (c *CloudHSM) DeleteLunaClientRequest(input *DeleteLunaClientInput) (req *request.Request, output *DeleteLunaClientOutput)
- func (c *CloudHSM) DescribeHapg(input *DescribeHapgInput) (*DescribeHapgOutput, error)
- func (c *CloudHSM) DescribeHapgRequest(input *DescribeHapgInput) (req *request.Request, output *DescribeHapgOutput)
- func (c *CloudHSM) DescribeHsm(input *DescribeHsmInput) (*DescribeHsmOutput, error)
- func (c *CloudHSM) DescribeHsmRequest(input *DescribeHsmInput) (req *request.Request, output *DescribeHsmOutput)
- func (c *CloudHSM) DescribeLunaClient(input *DescribeLunaClientInput) (*DescribeLunaClientOutput, error)
- func (c *CloudHSM) DescribeLunaClientRequest(input *DescribeLunaClientInput) (req *request.Request, output *DescribeLunaClientOutput)
- func (c *CloudHSM) GetConfig(input *GetConfigInput) (*GetConfigOutput, error)
- func (c *CloudHSM) GetConfigRequest(input *GetConfigInput) (req *request.Request, output *GetConfigOutput)
- func (c *CloudHSM) ListAvailableZones(input *ListAvailableZonesInput) (*ListAvailableZonesOutput, error)
- func (c *CloudHSM) ListAvailableZonesRequest(input *ListAvailableZonesInput) (req *request.Request, output *ListAvailableZonesOutput)
- func (c *CloudHSM) ListHapgs(input *ListHapgsInput) (*ListHapgsOutput, error)
- func (c *CloudHSM) ListHapgsRequest(input *ListHapgsInput) (req *request.Request, output *ListHapgsOutput)
- func (c *CloudHSM) ListHsms(input *ListHsmsInput) (*ListHsmsOutput, error)
- func (c *CloudHSM) ListHsmsRequest(input *ListHsmsInput) (req *request.Request, output *ListHsmsOutput)
- func (c *CloudHSM) ListLunaClients(input *ListLunaClientsInput) (*ListLunaClientsOutput, error)
- func (c *CloudHSM) ListLunaClientsRequest(input *ListLunaClientsInput) (req *request.Request, output *ListLunaClientsOutput)
- func (c *CloudHSM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
- func (c *CloudHSM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
- func (c *CloudHSM) ModifyHapg(input *ModifyHapgInput) (*ModifyHapgOutput, error)
- func (c *CloudHSM) ModifyHapgRequest(input *ModifyHapgInput) (req *request.Request, output *ModifyHapgOutput)
- func (c *CloudHSM) ModifyHsm(input *ModifyHsmInput) (*ModifyHsmOutput, error)
- func (c *CloudHSM) ModifyHsmRequest(input *ModifyHsmInput) (req *request.Request, output *ModifyHsmOutput)
- func (c *CloudHSM) ModifyLunaClient(input *ModifyLunaClientInput) (*ModifyLunaClientOutput, error)
- func (c *CloudHSM) ModifyLunaClientRequest(input *ModifyLunaClientInput) (req *request.Request, output *ModifyLunaClientOutput)
- func (c *CloudHSM) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)
- func (c *CloudHSM) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *RemoveTagsFromResourceOutput)
- type CreateHapgInput
- type CreateHapgOutput
- type CreateHsmInput
- type CreateHsmOutput
- type CreateLunaClientInput
- type CreateLunaClientOutput
- type DeleteHapgInput
- type DeleteHapgOutput
- type DeleteHsmInput
- type DeleteHsmOutput
- type DeleteLunaClientInput
- type DeleteLunaClientOutput
- type DescribeHapgInput
- type DescribeHapgOutput
- type DescribeHsmInput
- type DescribeHsmOutput
- type DescribeLunaClientInput
- type DescribeLunaClientOutput
- type GetConfigInput
- type GetConfigOutput
- type ListAvailableZonesInput
- type ListAvailableZonesOutput
- type ListHapgsInput
- type ListHapgsOutput
- type ListHsmsInput
- type ListHsmsOutput
- type ListLunaClientsInput
- type ListLunaClientsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ModifyHapgInput
- type ModifyHapgOutput
- type ModifyHsmInput
- type ModifyHsmOutput
- type ModifyLunaClientInput
- type ModifyLunaClientOutput
- type RemoveTagsFromResourceInput
- type RemoveTagsFromResourceOutput
- type Tag
Examples ¶
- CloudHSM.AddTagsToResource
- CloudHSM.CreateHapg
- CloudHSM.CreateHsm
- CloudHSM.CreateLunaClient
- CloudHSM.DeleteHapg
- CloudHSM.DeleteHsm
- CloudHSM.DeleteLunaClient
- CloudHSM.DescribeHapg
- CloudHSM.DescribeHsm
- CloudHSM.DescribeLunaClient
- CloudHSM.GetConfig
- CloudHSM.ListAvailableZones
- CloudHSM.ListHapgs
- CloudHSM.ListHsms
- CloudHSM.ListLunaClients
- CloudHSM.ListTagsForResource
- CloudHSM.ModifyHapg
- CloudHSM.ModifyHsm
- CloudHSM.ModifyLunaClient
- CloudHSM.RemoveTagsFromResource
Constants ¶
const ( // @enum ClientVersion ClientVersion51 = "5.1" // @enum ClientVersion ClientVersion53 = "5.3" )
const ( // @enum CloudHsmObjectState CloudHsmObjectStateReady = "READY" // @enum CloudHsmObjectState CloudHsmObjectStateUpdating = "UPDATING" // @enum CloudHsmObjectState CloudHsmObjectStateDegraded = "DEGRADED" )
const ( // @enum HsmStatus HsmStatusPending = "PENDING" // @enum HsmStatus HsmStatusRunning = "RUNNING" // @enum HsmStatus HsmStatusUpdating = "UPDATING" // @enum HsmStatus HsmStatusSuspended = "SUSPENDED" // @enum HsmStatus HsmStatusTerminating = "TERMINATING" // @enum HsmStatus HsmStatusTerminated = "TERMINATED" // @enum HsmStatus HsmStatusDegraded = "DEGRADED" )
const ServiceName = "cloudhsm"
A ServiceName is the name of the service the client will make API calls to.
const (
// @enum SubscriptionType
SubscriptionTypeProduction = "PRODUCTION"
)
Specifies the type of subscription for the HSM.
PRODUCTION - The HSM is being used in a production environment. TRIAL -
The HSM is being used in a product trial.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddTagsToResourceInput ¶
type AddTagsToResourceInput struct { // The Amazon Resource Name (ARN) of the AWS CloudHSM resource to tag. ResourceArn *string `type:"string" required:"true"` // One or more tags. TagList []*Tag `type:"list" required:"true"` // contains filtered or unexported fields }
func (AddTagsToResourceInput) GoString ¶
func (s AddTagsToResourceInput) GoString() string
GoString returns the string representation
func (AddTagsToResourceInput) String ¶
func (s AddTagsToResourceInput) String() string
String returns the string representation
func (*AddTagsToResourceInput) Validate ¶
func (s *AddTagsToResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type AddTagsToResourceOutput ¶
type AddTagsToResourceOutput struct { // The status of the operation. Status *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (AddTagsToResourceOutput) GoString ¶
func (s AddTagsToResourceOutput) GoString() string
GoString returns the string representation
func (AddTagsToResourceOutput) String ¶
func (s AddTagsToResourceOutput) String() string
String returns the string representation
type CloudHSM ¶
The service client's operations are safe to be used concurrently. It is not safe to mutate any of the client's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *CloudHSM
New creates a new instance of the CloudHSM client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a CloudHSM client from just a session. svc := cloudhsm.New(mySession) // Create a CloudHSM client with additional configuration svc := cloudhsm.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*CloudHSM) AddTagsToResource ¶
func (c *CloudHSM) AddTagsToResource(input *AddTagsToResourceInput) (*AddTagsToResourceOutput, error)
Adds or overwrites one or more tags for the specified AWS CloudHSM resource.
Each tag consists of a key and a value. Tag keys must be unique to each resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.AddTagsToResourceInput{ ResourceArn: aws.String("String"), // Required TagList: []*cloudhsm.Tag{ // Required { // Required Key: aws.String("TagKey"), // Required Value: aws.String("TagValue"), // Required }, // More values... }, } resp, err := svc.AddTagsToResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) AddTagsToResourceRequest ¶
func (c *CloudHSM) AddTagsToResourceRequest(input *AddTagsToResourceInput) (req *request.Request, output *AddTagsToResourceOutput)
AddTagsToResourceRequest generates a "aws/request.Request" representing the client's request for the AddTagsToResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the AddTagsToResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the AddTagsToResourceRequest method. req, resp := client.AddTagsToResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) CreateHapg ¶
func (c *CloudHSM) CreateHapg(input *CreateHapgInput) (*CreateHapgOutput, error)
Creates a high-availability partition group. A high-availability partition group is a group of partitions that spans multiple physical HSMs.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.CreateHapgInput{ Label: aws.String("Label"), // Required } resp, err := svc.CreateHapg(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) CreateHapgRequest ¶
func (c *CloudHSM) CreateHapgRequest(input *CreateHapgInput) (req *request.Request, output *CreateHapgOutput)
CreateHapgRequest generates a "aws/request.Request" representing the client's request for the CreateHapg operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateHapg method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateHapgRequest method. req, resp := client.CreateHapgRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) CreateHsm ¶
func (c *CloudHSM) CreateHsm(input *CreateHsmInput) (*CreateHsmOutput, error)
Creates an uninitialized HSM instance.
There is an upfront fee charged for each HSM instance that you create with the CreateHsm operation. If you accidentally provision an HSM and want to request a refund, delete the instance using the DeleteHsm operation, go to the AWS Support Center (https://console.aws.amazon.com/support/home#/), create a new case, and select Account and Billing Support.
It can take up to 20 minutes to create and provision an HSM. You can monitor
the status of the HSM with the DescribeHsm operation. The HSM is ready to be initialized when the status changes to RUNNING.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.CreateHsmInput{ IamRoleArn: aws.String("IamRoleArn"), // Required SshKey: aws.String("SshKey"), // Required SubnetId: aws.String("SubnetId"), // Required SubscriptionType: aws.String("SubscriptionType"), // Required ClientToken: aws.String("ClientToken"), EniIp: aws.String("IpAddress"), ExternalId: aws.String("ExternalId"), SyslogIp: aws.String("IpAddress"), } resp, err := svc.CreateHsm(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) CreateHsmRequest ¶
func (c *CloudHSM) CreateHsmRequest(input *CreateHsmInput) (req *request.Request, output *CreateHsmOutput)
CreateHsmRequest generates a "aws/request.Request" representing the client's request for the CreateHsm operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateHsm method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*CloudHSM) CreateLunaClient ¶
func (c *CloudHSM) CreateLunaClient(input *CreateLunaClientInput) (*CreateLunaClientOutput, error)
Creates an HSM client.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.CreateLunaClientInput{ Certificate: aws.String("Certificate"), // Required Label: aws.String("ClientLabel"), } resp, err := svc.CreateLunaClient(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) CreateLunaClientRequest ¶
func (c *CloudHSM) CreateLunaClientRequest(input *CreateLunaClientInput) (req *request.Request, output *CreateLunaClientOutput)
CreateLunaClientRequest generates a "aws/request.Request" representing the client's request for the CreateLunaClient operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the CreateLunaClient method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the CreateLunaClientRequest method. req, resp := client.CreateLunaClientRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) DeleteHapg ¶
func (c *CloudHSM) DeleteHapg(input *DeleteHapgInput) (*DeleteHapgOutput, error)
Deletes a high-availability partition group.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.DeleteHapgInput{ HapgArn: aws.String("HapgArn"), // Required } resp, err := svc.DeleteHapg(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) DeleteHapgRequest ¶
func (c *CloudHSM) DeleteHapgRequest(input *DeleteHapgInput) (req *request.Request, output *DeleteHapgOutput)
DeleteHapgRequest generates a "aws/request.Request" representing the client's request for the DeleteHapg operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteHapg method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteHapgRequest method. req, resp := client.DeleteHapgRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) DeleteHsm ¶
func (c *CloudHSM) DeleteHsm(input *DeleteHsmInput) (*DeleteHsmOutput, error)
Deletes an HSM. After completion, this operation cannot be undone and your key material cannot be recovered.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.DeleteHsmInput{ HsmArn: aws.String("HsmArn"), // Required } resp, err := svc.DeleteHsm(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) DeleteHsmRequest ¶
func (c *CloudHSM) DeleteHsmRequest(input *DeleteHsmInput) (req *request.Request, output *DeleteHsmOutput)
DeleteHsmRequest generates a "aws/request.Request" representing the client's request for the DeleteHsm operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteHsm method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// 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) }
func (*CloudHSM) DeleteLunaClient ¶
func (c *CloudHSM) DeleteLunaClient(input *DeleteLunaClientInput) (*DeleteLunaClientOutput, error)
Deletes a client.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.DeleteLunaClientInput{ ClientArn: aws.String("ClientArn"), // Required } resp, err := svc.DeleteLunaClient(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) DeleteLunaClientRequest ¶
func (c *CloudHSM) DeleteLunaClientRequest(input *DeleteLunaClientInput) (req *request.Request, output *DeleteLunaClientOutput)
DeleteLunaClientRequest generates a "aws/request.Request" representing the client's request for the DeleteLunaClient operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DeleteLunaClient method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DeleteLunaClientRequest method. req, resp := client.DeleteLunaClientRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) DescribeHapg ¶
func (c *CloudHSM) DescribeHapg(input *DescribeHapgInput) (*DescribeHapgOutput, error)
Retrieves information about a high-availability partition group.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.DescribeHapgInput{ HapgArn: aws.String("HapgArn"), // Required } resp, err := svc.DescribeHapg(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) DescribeHapgRequest ¶
func (c *CloudHSM) DescribeHapgRequest(input *DescribeHapgInput) (req *request.Request, output *DescribeHapgOutput)
DescribeHapgRequest generates a "aws/request.Request" representing the client's request for the DescribeHapg operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeHapg method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeHapgRequest method. req, resp := client.DescribeHapgRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) DescribeHsm ¶
func (c *CloudHSM) DescribeHsm(input *DescribeHsmInput) (*DescribeHsmOutput, error)
Retrieves information about an HSM. You can identify the HSM by its ARN or its serial number.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.DescribeHsmInput{ HsmArn: aws.String("HsmArn"), HsmSerialNumber: aws.String("HsmSerialNumber"), } resp, err := svc.DescribeHsm(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) DescribeHsmRequest ¶
func (c *CloudHSM) DescribeHsmRequest(input *DescribeHsmInput) (req *request.Request, output *DescribeHsmOutput)
DescribeHsmRequest generates a "aws/request.Request" representing the client's request for the DescribeHsm operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeHsm method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeHsmRequest method. req, resp := client.DescribeHsmRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) DescribeLunaClient ¶
func (c *CloudHSM) DescribeLunaClient(input *DescribeLunaClientInput) (*DescribeLunaClientOutput, error)
Retrieves information about an HSM client.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.DescribeLunaClientInput{ CertificateFingerprint: aws.String("CertificateFingerprint"), ClientArn: aws.String("ClientArn"), } resp, err := svc.DescribeLunaClient(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) DescribeLunaClientRequest ¶
func (c *CloudHSM) DescribeLunaClientRequest(input *DescribeLunaClientInput) (req *request.Request, output *DescribeLunaClientOutput)
DescribeLunaClientRequest generates a "aws/request.Request" representing the client's request for the DescribeLunaClient operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the DescribeLunaClient method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the DescribeLunaClientRequest method. req, resp := client.DescribeLunaClientRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) GetConfig ¶
func (c *CloudHSM) GetConfig(input *GetConfigInput) (*GetConfigOutput, error)
Gets the configuration files necessary to connect to all high availability partition groups the client is associated with.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.GetConfigInput{ ClientArn: aws.String("ClientArn"), // Required ClientVersion: aws.String("ClientVersion"), // Required HapgList: []*string{ // Required aws.String("HapgArn"), // Required // More values... }, } resp, err := svc.GetConfig(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) GetConfigRequest ¶
func (c *CloudHSM) GetConfigRequest(input *GetConfigInput) (req *request.Request, output *GetConfigOutput)
GetConfigRequest generates a "aws/request.Request" representing the client's request for the GetConfig operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the GetConfig method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the GetConfigRequest method. req, resp := client.GetConfigRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) ListAvailableZones ¶
func (c *CloudHSM) ListAvailableZones(input *ListAvailableZonesInput) (*ListAvailableZonesOutput, error)
Lists the Availability Zones that have available AWS CloudHSM capacity.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) var params *cloudhsm.ListAvailableZonesInput resp, err := svc.ListAvailableZones(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) ListAvailableZonesRequest ¶
func (c *CloudHSM) ListAvailableZonesRequest(input *ListAvailableZonesInput) (req *request.Request, output *ListAvailableZonesOutput)
ListAvailableZonesRequest generates a "aws/request.Request" representing the client's request for the ListAvailableZones operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListAvailableZones method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListAvailableZonesRequest method. req, resp := client.ListAvailableZonesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) ListHapgs ¶
func (c *CloudHSM) ListHapgs(input *ListHapgsInput) (*ListHapgsOutput, error)
Lists the high-availability partition groups for the account.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHapgs to retrieve the next set of items.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.ListHapgsInput{ NextToken: aws.String("PaginationToken"), } resp, err := svc.ListHapgs(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) ListHapgsRequest ¶
func (c *CloudHSM) ListHapgsRequest(input *ListHapgsInput) (req *request.Request, output *ListHapgsOutput)
ListHapgsRequest generates a "aws/request.Request" representing the client's request for the ListHapgs operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListHapgs method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListHapgsRequest method. req, resp := client.ListHapgsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) ListHsms ¶
func (c *CloudHSM) ListHsms(input *ListHsmsInput) (*ListHsmsOutput, error)
Retrieves the identifiers of all of the HSMs provisioned for the current customer.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListHsms to retrieve the next set of items.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.ListHsmsInput{ NextToken: aws.String("PaginationToken"), } resp, err := svc.ListHsms(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) ListHsmsRequest ¶
func (c *CloudHSM) ListHsmsRequest(input *ListHsmsInput) (req *request.Request, output *ListHsmsOutput)
ListHsmsRequest generates a "aws/request.Request" representing the client's request for the ListHsms operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListHsms method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListHsmsRequest method. req, resp := client.ListHsmsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) ListLunaClients ¶
func (c *CloudHSM) ListLunaClients(input *ListLunaClientsInput) (*ListLunaClientsOutput, error)
Lists all of the clients.
This operation supports pagination with the use of the NextToken member. If more results are available, the NextToken member of the response contains a token that you pass in the next call to ListLunaClients to retrieve the next set of items.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.ListLunaClientsInput{ NextToken: aws.String("PaginationToken"), } resp, err := svc.ListLunaClients(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) ListLunaClientsRequest ¶
func (c *CloudHSM) ListLunaClientsRequest(input *ListLunaClientsInput) (req *request.Request, output *ListLunaClientsOutput)
ListLunaClientsRequest generates a "aws/request.Request" representing the client's request for the ListLunaClients operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListLunaClients method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListLunaClientsRequest method. req, resp := client.ListLunaClientsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) ListTagsForResource ¶
func (c *CloudHSM) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
Returns a list of all tags for the specified AWS CloudHSM resource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.ListTagsForResourceInput{ ResourceArn: aws.String("String"), // Required } resp, err := svc.ListTagsForResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) ListTagsForResourceRequest ¶
func (c *CloudHSM) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ListTagsForResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ListTagsForResourceRequest method. req, resp := client.ListTagsForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) ModifyHapg ¶
func (c *CloudHSM) ModifyHapg(input *ModifyHapgInput) (*ModifyHapgOutput, error)
Modifies an existing high-availability partition group.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.ModifyHapgInput{ HapgArn: aws.String("HapgArn"), // Required Label: aws.String("Label"), PartitionSerialList: []*string{ aws.String("PartitionSerial"), // Required // More values... }, } resp, err := svc.ModifyHapg(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) ModifyHapgRequest ¶
func (c *CloudHSM) ModifyHapgRequest(input *ModifyHapgInput) (req *request.Request, output *ModifyHapgOutput)
ModifyHapgRequest generates a "aws/request.Request" representing the client's request for the ModifyHapg operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ModifyHapg method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ModifyHapgRequest method. req, resp := client.ModifyHapgRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) ModifyHsm ¶
func (c *CloudHSM) ModifyHsm(input *ModifyHsmInput) (*ModifyHsmOutput, error)
Modifies an HSM.
This operation can result in the HSM being offline for up to 15 minutes
while the AWS CloudHSM service is reconfigured. If you are modifying a production HSM, you should ensure that your AWS CloudHSM service is configured for high availability, and consider executing this operation during a maintenance window.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.ModifyHsmInput{ HsmArn: aws.String("HsmArn"), // Required EniIp: aws.String("IpAddress"), ExternalId: aws.String("ExternalId"), IamRoleArn: aws.String("IamRoleArn"), SubnetId: aws.String("SubnetId"), SyslogIp: aws.String("IpAddress"), } resp, err := svc.ModifyHsm(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) ModifyHsmRequest ¶
func (c *CloudHSM) ModifyHsmRequest(input *ModifyHsmInput) (req *request.Request, output *ModifyHsmOutput)
ModifyHsmRequest generates a "aws/request.Request" representing the client's request for the ModifyHsm operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ModifyHsm method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ModifyHsmRequest method. req, resp := client.ModifyHsmRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) ModifyLunaClient ¶
func (c *CloudHSM) ModifyLunaClient(input *ModifyLunaClientInput) (*ModifyLunaClientOutput, error)
Modifies the certificate used by the client.
This action can potentially start a workflow to install the new certificate on the client's HSMs.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.ModifyLunaClientInput{ Certificate: aws.String("Certificate"), // Required ClientArn: aws.String("ClientArn"), // Required } resp, err := svc.ModifyLunaClient(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) ModifyLunaClientRequest ¶
func (c *CloudHSM) ModifyLunaClientRequest(input *ModifyLunaClientInput) (req *request.Request, output *ModifyLunaClientOutput)
ModifyLunaClientRequest generates a "aws/request.Request" representing the client's request for the ModifyLunaClient operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the ModifyLunaClient method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the ModifyLunaClientRequest method. req, resp := client.ModifyLunaClientRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
func (*CloudHSM) RemoveTagsFromResource ¶
func (c *CloudHSM) RemoveTagsFromResource(input *RemoveTagsFromResourceInput) (*RemoveTagsFromResourceOutput, error)
Removes one or more tags from the specified AWS CloudHSM resource.
To remove a tag, specify only the tag key to remove (not the value). To overwrite the value for an existing tag, use AddTagsToResource.
Example ¶
package main import ( "fmt" "github.com/aws/aws-sdk-go/aws" "github.com/aws/aws-sdk-go/aws/session" "github.com/aws/aws-sdk-go/service/cloudhsm" ) func main() { sess, err := session.NewSession() if err != nil { fmt.Println("failed to create session,", err) return } svc := cloudhsm.New(sess) params := &cloudhsm.RemoveTagsFromResourceInput{ ResourceArn: aws.String("String"), // Required TagKeyList: []*string{ // Required aws.String("TagKey"), // Required // More values... }, } resp, err := svc.RemoveTagsFromResource(params) if err != nil { // Print the error, cast err to awserr.Error to get the Code and // Message from an error. fmt.Println(err.Error()) return } // Pretty-print the response data. fmt.Println(resp) }
Output:
func (*CloudHSM) RemoveTagsFromResourceRequest ¶
func (c *CloudHSM) RemoveTagsFromResourceRequest(input *RemoveTagsFromResourceInput) (req *request.Request, output *RemoveTagsFromResourceOutput)
RemoveTagsFromResourceRequest generates a "aws/request.Request" representing the client's request for the RemoveTagsFromResource operation. The "output" return value can be used to capture response data after the request's "Send" method is called.
Creating a request object using this method should be used when you want to inject custom logic into the request's lifecycle using a custom handler, or if you want to access properties on the request object before or after sending the request. If you just want the service response, call the RemoveTagsFromResource method directly instead.
Note: You must call the "Send" method on the returned request object in order to execute the request.
// Example sending a request using the RemoveTagsFromResourceRequest method. req, resp := client.RemoveTagsFromResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
type CreateHapgInput ¶
type CreateHapgInput struct { // The label of the new high-availability partition group. Label *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the CreateHapgRequest action.
func (CreateHapgInput) GoString ¶
func (s CreateHapgInput) GoString() string
GoString returns the string representation
func (CreateHapgInput) String ¶
func (s CreateHapgInput) String() string
String returns the string representation
func (*CreateHapgInput) Validate ¶
func (s *CreateHapgInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateHapgOutput ¶
type CreateHapgOutput struct { // The ARN of the high-availability partition group. HapgArn *string `type:"string"` // contains filtered or unexported fields }
Contains the output of the CreateHAPartitionGroup action.
func (CreateHapgOutput) GoString ¶
func (s CreateHapgOutput) GoString() string
GoString returns the string representation
func (CreateHapgOutput) String ¶
func (s CreateHapgOutput) String() string
String returns the string representation
type CreateHsmInput ¶
type CreateHsmInput struct { // A user-defined token to ensure idempotence. Subsequent calls to this operation // with the same token will be ignored. ClientToken *string `locationName:"ClientToken" type:"string"` // The IP address to assign to the HSM's ENI. // // If an IP address is not specified, an IP address will be randomly chosen // from the CIDR range of the subnet. EniIp *string `locationName:"EniIp" type:"string"` // The external ID from IamRoleArn, if present. ExternalId *string `locationName:"ExternalId" type:"string"` // The ARN of an IAM role to enable the AWS CloudHSM service to allocate an // ENI on your behalf. IamRoleArn *string `locationName:"IamRoleArn" type:"string" required:"true"` // The SSH public key to install on the HSM. SshKey *string `locationName:"SshKey" type:"string" required:"true"` // The identifier of the subnet in your VPC in which to place the HSM. SubnetId *string `locationName:"SubnetId" type:"string" required:"true"` // Specifies the type of subscription for the HSM. // // PRODUCTION - The HSM is being used in a production environment. TRIAL - // The HSM is being used in a product trial. SubscriptionType *string `locationName:"SubscriptionType" type:"string" required:"true" enum:"SubscriptionType"` // The IP address for the syslog monitoring server. The AWS CloudHSM service // only supports one syslog monitoring server. SyslogIp *string `locationName:"SyslogIp" type:"string"` // contains filtered or unexported fields }
Contains the inputs for the CreateHsm operation.
func (CreateHsmInput) GoString ¶
func (s CreateHsmInput) GoString() string
GoString returns the string representation
func (CreateHsmInput) String ¶
func (s CreateHsmInput) String() string
String returns the string representation
func (*CreateHsmInput) Validate ¶
func (s *CreateHsmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateHsmOutput ¶
type CreateHsmOutput struct { // The ARN of the HSM. HsmArn *string `type:"string"` // contains filtered or unexported fields }
Contains the output of the CreateHsm operation.
func (CreateHsmOutput) GoString ¶
func (s CreateHsmOutput) GoString() string
GoString returns the string representation
func (CreateHsmOutput) String ¶
func (s CreateHsmOutput) String() string
String returns the string representation
type CreateLunaClientInput ¶
type CreateLunaClientInput struct { // The contents of a Base64-Encoded X.509 v3 certificate to be installed on // the HSMs used by this client. Certificate *string `min:"600" type:"string" required:"true"` // The label for the client. Label *string `type:"string"` // contains filtered or unexported fields }
Contains the inputs for the CreateLunaClient action.
func (CreateLunaClientInput) GoString ¶
func (s CreateLunaClientInput) GoString() string
GoString returns the string representation
func (CreateLunaClientInput) String ¶
func (s CreateLunaClientInput) String() string
String returns the string representation
func (*CreateLunaClientInput) Validate ¶
func (s *CreateLunaClientInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateLunaClientOutput ¶
type CreateLunaClientOutput struct { // The ARN of the client. ClientArn *string `type:"string"` // contains filtered or unexported fields }
Contains the output of the CreateLunaClient action.
func (CreateLunaClientOutput) GoString ¶
func (s CreateLunaClientOutput) GoString() string
GoString returns the string representation
func (CreateLunaClientOutput) String ¶
func (s CreateLunaClientOutput) String() string
String returns the string representation
type DeleteHapgInput ¶
type DeleteHapgInput struct { // The ARN of the high-availability partition group to delete. HapgArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the DeleteHapg action.
func (DeleteHapgInput) GoString ¶
func (s DeleteHapgInput) GoString() string
GoString returns the string representation
func (DeleteHapgInput) String ¶
func (s DeleteHapgInput) String() string
String returns the string representation
func (*DeleteHapgInput) Validate ¶
func (s *DeleteHapgInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteHapgOutput ¶
type DeleteHapgOutput struct { // The status of the action. Status *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the output of the DeleteHapg action.
func (DeleteHapgOutput) GoString ¶
func (s DeleteHapgOutput) GoString() string
GoString returns the string representation
func (DeleteHapgOutput) String ¶
func (s DeleteHapgOutput) String() string
String returns the string representation
type DeleteHsmInput ¶
type DeleteHsmInput struct { // The ARN of the HSM to delete. HsmArn *string `locationName:"HsmArn" type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the DeleteHsm operation.
func (DeleteHsmInput) GoString ¶
func (s DeleteHsmInput) GoString() string
GoString returns the string representation
func (DeleteHsmInput) String ¶
func (s DeleteHsmInput) String() string
String returns the string representation
func (*DeleteHsmInput) Validate ¶
func (s *DeleteHsmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteHsmOutput ¶
type DeleteHsmOutput struct { // The status of the operation. Status *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the output of the DeleteHsm operation.
func (DeleteHsmOutput) GoString ¶
func (s DeleteHsmOutput) GoString() string
GoString returns the string representation
func (DeleteHsmOutput) String ¶
func (s DeleteHsmOutput) String() string
String returns the string representation
type DeleteLunaClientInput ¶
type DeleteLunaClientInput struct { // The ARN of the client to delete. ClientArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteLunaClientInput) GoString ¶
func (s DeleteLunaClientInput) GoString() string
GoString returns the string representation
func (DeleteLunaClientInput) String ¶
func (s DeleteLunaClientInput) String() string
String returns the string representation
func (*DeleteLunaClientInput) Validate ¶
func (s *DeleteLunaClientInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteLunaClientOutput ¶
type DeleteLunaClientOutput struct { // The status of the action. Status *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (DeleteLunaClientOutput) GoString ¶
func (s DeleteLunaClientOutput) GoString() string
GoString returns the string representation
func (DeleteLunaClientOutput) String ¶
func (s DeleteLunaClientOutput) String() string
String returns the string representation
type DescribeHapgInput ¶
type DescribeHapgInput struct { // The ARN of the high-availability partition group to describe. HapgArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
Contains the inputs for the DescribeHapg action.
func (DescribeHapgInput) GoString ¶
func (s DescribeHapgInput) GoString() string
GoString returns the string representation
func (DescribeHapgInput) String ¶
func (s DescribeHapgInput) String() string
String returns the string representation
func (*DescribeHapgInput) Validate ¶
func (s *DescribeHapgInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeHapgOutput ¶
type DescribeHapgOutput struct { // The ARN of the high-availability partition group. HapgArn *string `type:"string"` // The serial number of the high-availability partition group. HapgSerial *string `type:"string"` // Contains a list of ARNs that identify the HSMs. HsmsLastActionFailed []*string `type:"list"` // Contains a list of ARNs that identify the HSMs. HsmsPendingDeletion []*string `type:"list"` // Contains a list of ARNs that identify the HSMs. HsmsPendingRegistration []*string `type:"list"` // The label for the high-availability partition group. Label *string `type:"string"` // The date and time the high-availability partition group was last modified. LastModifiedTimestamp *string `type:"string"` // The list of partition serial numbers that belong to the high-availability // partition group. PartitionSerialList []*string `type:"list"` // The state of the high-availability partition group. State *string `type:"string" enum:"CloudHsmObjectState"` // contains filtered or unexported fields }
Contains the output of the DescribeHapg action.
func (DescribeHapgOutput) GoString ¶
func (s DescribeHapgOutput) GoString() string
GoString returns the string representation
func (DescribeHapgOutput) String ¶
func (s DescribeHapgOutput) String() string
String returns the string representation
type DescribeHsmInput ¶
type DescribeHsmInput struct { // The ARN of the HSM. Either the HsmArn or the SerialNumber parameter must // be specified. HsmArn *string `type:"string"` // The serial number of the HSM. Either the HsmArn or the HsmSerialNumber parameter // must be specified. HsmSerialNumber *string `type:"string"` // contains filtered or unexported fields }
Contains the inputs for the DescribeHsm operation.
func (DescribeHsmInput) GoString ¶
func (s DescribeHsmInput) GoString() string
GoString returns the string representation
func (DescribeHsmInput) String ¶
func (s DescribeHsmInput) String() string
String returns the string representation
type DescribeHsmOutput ¶
type DescribeHsmOutput struct { // The Availability Zone that the HSM is in. AvailabilityZone *string `type:"string"` // The identifier of the elastic network interface (ENI) attached to the HSM. EniId *string `type:"string"` // The IP address assigned to the HSM's ENI. EniIp *string `type:"string"` // The ARN of the HSM. HsmArn *string `type:"string"` // The HSM model type. HsmType *string `type:"string"` // The ARN of the IAM role assigned to the HSM. IamRoleArn *string `type:"string"` // The list of partitions on the HSM. Partitions []*string `type:"list"` // The serial number of the HSM. SerialNumber *string `type:"string"` // The date and time that the server certificate was last updated. ServerCertLastUpdated *string `type:"string"` // The URI of the certificate server. ServerCertUri *string `type:"string"` // The HSM software version. SoftwareVersion *string `type:"string"` // The date and time that the SSH key was last updated. SshKeyLastUpdated *string `type:"string"` // The public SSH key. SshPublicKey *string `type:"string"` // The status of the HSM. Status *string `type:"string" enum:"HsmStatus"` // Contains additional information about the status of the HSM. StatusDetails *string `type:"string"` // The identifier of the subnet that the HSM is in. SubnetId *string `type:"string"` // The subscription end date. SubscriptionEndDate *string `type:"string"` // The subscription start date. SubscriptionStartDate *string `type:"string"` // Specifies the type of subscription for the HSM. // // PRODUCTION - The HSM is being used in a production environment. TRIAL - // The HSM is being used in a product trial. SubscriptionType *string `type:"string" enum:"SubscriptionType"` // The name of the HSM vendor. VendorName *string `type:"string"` // The identifier of the VPC that the HSM is in. VpcId *string `type:"string"` // contains filtered or unexported fields }
Contains the output of the DescribeHsm operation.
func (DescribeHsmOutput) GoString ¶
func (s DescribeHsmOutput) GoString() string
GoString returns the string representation
func (DescribeHsmOutput) String ¶
func (s DescribeHsmOutput) String() string
String returns the string representation
type DescribeLunaClientInput ¶
type DescribeLunaClientInput struct { // The certificate fingerprint. CertificateFingerprint *string `type:"string"` // The ARN of the client. ClientArn *string `type:"string"` // contains filtered or unexported fields }
func (DescribeLunaClientInput) GoString ¶
func (s DescribeLunaClientInput) GoString() string
GoString returns the string representation
func (DescribeLunaClientInput) String ¶
func (s DescribeLunaClientInput) String() string
String returns the string representation
type DescribeLunaClientOutput ¶
type DescribeLunaClientOutput struct { // The certificate installed on the HSMs used by this client. Certificate *string `min:"600" type:"string"` // The certificate fingerprint. CertificateFingerprint *string `type:"string"` // The ARN of the client. ClientArn *string `type:"string"` // The label of the client. Label *string `type:"string"` // The date and time the client was last modified. LastModifiedTimestamp *string `type:"string"` // contains filtered or unexported fields }
func (DescribeLunaClientOutput) GoString ¶
func (s DescribeLunaClientOutput) GoString() string
GoString returns the string representation
func (DescribeLunaClientOutput) String ¶
func (s DescribeLunaClientOutput) String() string
String returns the string representation
type GetConfigInput ¶
type GetConfigInput struct { // The ARN of the client. ClientArn *string `type:"string" required:"true"` // The client version. ClientVersion *string `type:"string" required:"true" enum:"ClientVersion"` // A list of ARNs that identify the high-availability partition groups that // are associated with the client. HapgList []*string `type:"list" required:"true"` // contains filtered or unexported fields }
func (GetConfigInput) GoString ¶
func (s GetConfigInput) GoString() string
GoString returns the string representation
func (GetConfigInput) String ¶
func (s GetConfigInput) String() string
String returns the string representation
func (*GetConfigInput) Validate ¶
func (s *GetConfigInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type GetConfigOutput ¶
type GetConfigOutput struct { // The certificate file containing the server.pem files of the HSMs. ConfigCred *string `type:"string"` // The chrystoki.conf configuration file. ConfigFile *string `type:"string"` // The type of credentials. ConfigType *string `type:"string"` // contains filtered or unexported fields }
func (GetConfigOutput) GoString ¶
func (s GetConfigOutput) GoString() string
GoString returns the string representation
func (GetConfigOutput) String ¶
func (s GetConfigOutput) String() string
String returns the string representation
type ListAvailableZonesInput ¶
type ListAvailableZonesInput struct {
// contains filtered or unexported fields
}
Contains the inputs for the ListAvailableZones action.
func (ListAvailableZonesInput) GoString ¶
func (s ListAvailableZonesInput) GoString() string
GoString returns the string representation
func (ListAvailableZonesInput) String ¶
func (s ListAvailableZonesInput) String() string
String returns the string representation
type ListAvailableZonesOutput ¶
type ListAvailableZonesOutput struct { // The list of Availability Zones that have available AWS CloudHSM capacity. AZList []*string `type:"list"` // contains filtered or unexported fields }
func (ListAvailableZonesOutput) GoString ¶
func (s ListAvailableZonesOutput) GoString() string
GoString returns the string representation
func (ListAvailableZonesOutput) String ¶
func (s ListAvailableZonesOutput) String() string
String returns the string representation
type ListHapgsInput ¶
type ListHapgsInput struct { // The NextToken value from a previous call to ListHapgs. Pass null if this // is the first call. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListHapgsInput) GoString ¶
func (s ListHapgsInput) GoString() string
GoString returns the string representation
func (ListHapgsInput) String ¶
func (s ListHapgsInput) String() string
String returns the string representation
type ListHapgsOutput ¶
type ListHapgsOutput struct { // The list of high-availability partition groups. HapgList []*string `type:"list" required:"true"` // If not null, more results are available. Pass this value to ListHapgs to // retrieve the next set of items. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListHapgsOutput) GoString ¶
func (s ListHapgsOutput) GoString() string
GoString returns the string representation
func (ListHapgsOutput) String ¶
func (s ListHapgsOutput) String() string
String returns the string representation
type ListHsmsInput ¶
type ListHsmsInput struct { // The NextToken value from a previous call to ListHsms. Pass null if this is // the first call. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListHsmsInput) GoString ¶
func (s ListHsmsInput) GoString() string
GoString returns the string representation
func (ListHsmsInput) String ¶
func (s ListHsmsInput) String() string
String returns the string representation
type ListHsmsOutput ¶
type ListHsmsOutput struct { // The list of ARNs that identify the HSMs. HsmList []*string `type:"list"` // If not null, more results are available. Pass this value to ListHsms to retrieve // the next set of items. NextToken *string `type:"string"` // contains filtered or unexported fields }
Contains the output of the ListHsms operation.
func (ListHsmsOutput) GoString ¶
func (s ListHsmsOutput) GoString() string
GoString returns the string representation
func (ListHsmsOutput) String ¶
func (s ListHsmsOutput) String() string
String returns the string representation
type ListLunaClientsInput ¶
type ListLunaClientsInput struct { // The NextToken value from a previous call to ListLunaClients. Pass null if // this is the first call. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListLunaClientsInput) GoString ¶
func (s ListLunaClientsInput) GoString() string
GoString returns the string representation
func (ListLunaClientsInput) String ¶
func (s ListLunaClientsInput) String() string
String returns the string representation
type ListLunaClientsOutput ¶
type ListLunaClientsOutput struct { // The list of clients. ClientList []*string `type:"list" required:"true"` // If not null, more results are available. Pass this to ListLunaClients to // retrieve the next set of items. NextToken *string `type:"string"` // contains filtered or unexported fields }
func (ListLunaClientsOutput) GoString ¶
func (s ListLunaClientsOutput) GoString() string
GoString returns the string representation
func (ListLunaClientsOutput) String ¶
func (s ListLunaClientsOutput) String() string
String returns the string representation
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the AWS CloudHSM resource. ResourceArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceInput) GoString ¶
func (s ListTagsForResourceInput) GoString() string
GoString returns the string representation
func (ListTagsForResourceInput) String ¶
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // One or more tags. TagList []*Tag `type:"list" required:"true"` // contains filtered or unexported fields }
func (ListTagsForResourceOutput) GoString ¶
func (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation
func (ListTagsForResourceOutput) String ¶
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ModifyHapgInput ¶
type ModifyHapgInput struct { // The ARN of the high-availability partition group to modify. HapgArn *string `type:"string" required:"true"` // The new label for the high-availability partition group. Label *string `type:"string"` // The list of partition serial numbers to make members of the high-availability // partition group. PartitionSerialList []*string `type:"list"` // contains filtered or unexported fields }
func (ModifyHapgInput) GoString ¶
func (s ModifyHapgInput) GoString() string
GoString returns the string representation
func (ModifyHapgInput) String ¶
func (s ModifyHapgInput) String() string
String returns the string representation
func (*ModifyHapgInput) Validate ¶
func (s *ModifyHapgInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ModifyHapgOutput ¶
type ModifyHapgOutput struct { // The ARN of the high-availability partition group. HapgArn *string `type:"string"` // contains filtered or unexported fields }
func (ModifyHapgOutput) GoString ¶
func (s ModifyHapgOutput) GoString() string
GoString returns the string representation
func (ModifyHapgOutput) String ¶
func (s ModifyHapgOutput) String() string
String returns the string representation
type ModifyHsmInput ¶
type ModifyHsmInput struct { // The new IP address for the elastic network interface (ENI) attached to the // HSM. // // If the HSM is moved to a different subnet, and an IP address is not specified, // an IP address will be randomly chosen from the CIDR range of the new subnet. EniIp *string `locationName:"EniIp" type:"string"` // The new external ID. ExternalId *string `locationName:"ExternalId" type:"string"` // The ARN of the HSM to modify. HsmArn *string `locationName:"HsmArn" type:"string" required:"true"` // The new IAM role ARN. IamRoleArn *string `locationName:"IamRoleArn" type:"string"` // The new identifier of the subnet that the HSM is in. The new subnet must // be in the same Availability Zone as the current subnet. SubnetId *string `locationName:"SubnetId" type:"string"` // The new IP address for the syslog monitoring server. The AWS CloudHSM service // only supports one syslog monitoring server. SyslogIp *string `locationName:"SyslogIp" type:"string"` // contains filtered or unexported fields }
Contains the inputs for the ModifyHsm operation.
func (ModifyHsmInput) GoString ¶
func (s ModifyHsmInput) GoString() string
GoString returns the string representation
func (ModifyHsmInput) String ¶
func (s ModifyHsmInput) String() string
String returns the string representation
func (*ModifyHsmInput) Validate ¶
func (s *ModifyHsmInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ModifyHsmOutput ¶
type ModifyHsmOutput struct { // The ARN of the HSM. HsmArn *string `type:"string"` // contains filtered or unexported fields }
Contains the output of the ModifyHsm operation.
func (ModifyHsmOutput) GoString ¶
func (s ModifyHsmOutput) GoString() string
GoString returns the string representation
func (ModifyHsmOutput) String ¶
func (s ModifyHsmOutput) String() string
String returns the string representation
type ModifyLunaClientInput ¶
type ModifyLunaClientInput struct { // The new certificate for the client. Certificate *string `min:"600" type:"string" required:"true"` // The ARN of the client. ClientArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (ModifyLunaClientInput) GoString ¶
func (s ModifyLunaClientInput) GoString() string
GoString returns the string representation
func (ModifyLunaClientInput) String ¶
func (s ModifyLunaClientInput) String() string
String returns the string representation
func (*ModifyLunaClientInput) Validate ¶
func (s *ModifyLunaClientInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ModifyLunaClientOutput ¶
type ModifyLunaClientOutput struct { // The ARN of the client. ClientArn *string `type:"string"` // contains filtered or unexported fields }
func (ModifyLunaClientOutput) GoString ¶
func (s ModifyLunaClientOutput) GoString() string
GoString returns the string representation
func (ModifyLunaClientOutput) String ¶
func (s ModifyLunaClientOutput) String() string
String returns the string representation
type RemoveTagsFromResourceInput ¶
type RemoveTagsFromResourceInput struct { // The Amazon Resource Name (ARN) of the AWS CloudHSM resource. ResourceArn *string `type:"string" required:"true"` // The tag key or keys to remove. // // Specify only the tag key to remove (not the value). To overwrite the value // for an existing tag, use AddTagsToResource. TagKeyList []*string `type:"list" required:"true"` // contains filtered or unexported fields }
func (RemoveTagsFromResourceInput) GoString ¶
func (s RemoveTagsFromResourceInput) GoString() string
GoString returns the string representation
func (RemoveTagsFromResourceInput) String ¶
func (s RemoveTagsFromResourceInput) String() string
String returns the string representation
func (*RemoveTagsFromResourceInput) Validate ¶
func (s *RemoveTagsFromResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type RemoveTagsFromResourceOutput ¶
type RemoveTagsFromResourceOutput struct { // The status of the operation. Status *string `type:"string" required:"true"` // contains filtered or unexported fields }
func (RemoveTagsFromResourceOutput) GoString ¶
func (s RemoveTagsFromResourceOutput) GoString() string
GoString returns the string representation
func (RemoveTagsFromResourceOutput) String ¶
func (s RemoveTagsFromResourceOutput) String() string
String returns the string representation
type Tag ¶
type Tag struct { // The key of the tag. Key *string `min:"1" type:"string" required:"true"` // The value of the tag. Value *string `type:"string" required:"true"` // contains filtered or unexported fields }
A key-value pair that identifies or specifies metadata about an AWS CloudHSM resource.
Directories
¶
Path | Synopsis |
---|---|
Package cloudhsmiface provides an interface for the Amazon CloudHSM.
|
Package cloudhsmiface provides an interface for the Amazon CloudHSM. |