cloudhsm

package
v1.1.6 Latest Latest
Warning

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

 Go to latest Published: Feb 26, 2016 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package cloudhsm provides a client for Amazon CloudHSM.

Index

Examples

Constants

View Source 
const (
	// @enum ClientVersion
	ClientVersion51 = "5.1"
	// @enum ClientVersion
	ClientVersion53 = "5.3"
)
View Source 
const (
	// @enum CloudHsmObjectState
	CloudHsmObjectStateReady = "READY"
	// @enum CloudHsmObjectState
	CloudHsmObjectStateUpdating = "UPDATING"
	// @enum CloudHsmObjectState
	CloudHsmObjectStateDegraded = "DEGRADED"
)
View Source 
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"
)
View Source 
const ServiceName = "cloudhsm"

A ServiceName is the name of the service the client will make API calls to.

View Source 
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 CloudHSM 

type CloudHSM struct {
	*client.Client
}

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) CreateHapg added in v0.9.5 

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() {
	svc := cloudhsm.New(session.New())

	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 added in v0.9.5 

func (c *CloudHSM) CreateHapgRequest(input *CreateHapgInput) (req *request.Request, output *CreateHapgOutput)

CreateHapgRequest generates a request for the CreateHapg operation.

func (*CloudHSM) CreateHsm added in v0.9.5 

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() {
	svc := cloudhsm.New(session.New())

	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 added in v0.9.5 

func (c *CloudHSM) CreateHsmRequest(input *CreateHsmInput) (req *request.Request, output *CreateHsmOutput)

CreateHsmRequest generates a request for the CreateHsm operation.

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() {
	svc := cloudhsm.New(session.New())

	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 request for the CreateLunaClient operation.

func (*CloudHSM) DeleteHapg added in v0.9.5 

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() {
	svc := cloudhsm.New(session.New())

	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 added in v0.9.5 

func (c *CloudHSM) DeleteHapgRequest(input *DeleteHapgInput) (req *request.Request, output *DeleteHapgOutput)

DeleteHapgRequest generates a request for the DeleteHapg operation.

func (*CloudHSM) DeleteHsm added in v0.9.5 

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() {
	svc := cloudhsm.New(session.New())

	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 added in v0.9.5 

func (c *CloudHSM) DeleteHsmRequest(input *DeleteHsmInput) (req *request.Request, output *DeleteHsmOutput)

DeleteHsmRequest generates a request for the DeleteHsm operation.

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() {
	svc := cloudhsm.New(session.New())

	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 request for the DeleteLunaClient operation.

func (*CloudHSM) DescribeHapg added in v0.9.5 

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() {
	svc := cloudhsm.New(session.New())

	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 added in v0.9.5 

func (c *CloudHSM) DescribeHapgRequest(input *DescribeHapgInput) (req *request.Request, output *DescribeHapgOutput)

DescribeHapgRequest generates a request for the DescribeHapg operation.

func (*CloudHSM) DescribeHsm added in v0.9.5 

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() {
	svc := cloudhsm.New(session.New())

	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 added in v0.9.5 

func (c *CloudHSM) DescribeHsmRequest(input *DescribeHsmInput) (req *request.Request, output *DescribeHsmOutput)

DescribeHsmRequest generates a request for the DescribeHsm operation.

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() {
	svc := cloudhsm.New(session.New())

	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 request for the DescribeLunaClient operation.

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() {
	svc := cloudhsm.New(session.New())

	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 request for the GetConfig operation.

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() {
	svc := cloudhsm.New(session.New())

	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 request for the ListAvailableZones operation.

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() {
	svc := cloudhsm.New(session.New())

	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 request for the ListHapgs operation.

func (*CloudHSM) ListHsms added in v0.9.5 

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() {
	svc := cloudhsm.New(session.New())

	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 added in v0.9.5 

func (c *CloudHSM) ListHsmsRequest(input *ListHsmsInput) (req *request.Request, output *ListHsmsOutput)

ListHsmsRequest generates a request for the ListHsms operation.

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() {
	svc := cloudhsm.New(session.New())

	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 request for the ListLunaClients operation.

func (*CloudHSM) ModifyHapg added in v0.9.5 

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() {
	svc := cloudhsm.New(session.New())

	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 added in v0.9.5 

func (c *CloudHSM) ModifyHapgRequest(input *ModifyHapgInput) (req *request.Request, output *ModifyHapgOutput)

ModifyHapgRequest generates a request for the ModifyHapg operation.

func (*CloudHSM) ModifyHsm added in v0.9.5 

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() {
	svc := cloudhsm.New(session.New())

	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 added in v0.9.5 

func (c *CloudHSM) ModifyHsmRequest(input *ModifyHsmInput) (req *request.Request, output *ModifyHsmOutput)

ModifyHsmRequest generates a request for the ModifyHsm operation.

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() {
	svc := cloudhsm.New(session.New())

	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 request for the ModifyLunaClient operation.

type CreateHapgInput added in v0.9.5 

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 added in v0.9.5 

func (s CreateHapgInput) GoString() string

GoString returns the string representation

func (CreateHapgInput) String added in v0.9.5 

func (s CreateHapgInput) String() string

String returns the string representation

type CreateHapgOutput added in v0.9.5 

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 added in v0.9.5 

func (s CreateHapgOutput) GoString() string

GoString returns the string representation

func (CreateHapgOutput) String added in v0.9.5 

func (s CreateHapgOutput) String() string

String returns the string representation

type CreateHsmInput added in v0.9.5 

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 added in v0.9.5 

func (s CreateHsmInput) GoString() string

GoString returns the string representation

func (CreateHsmInput) String added in v0.9.5 

func (s CreateHsmInput) String() string

String returns the string representation

type CreateHsmOutput added in v0.9.5 

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 added in v0.9.5 

func (s CreateHsmOutput) GoString() string

GoString returns the string representation

func (CreateHsmOutput) String added in v0.9.5 

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 added in v0.6.6 

func (s CreateLunaClientInput) GoString() string

GoString returns the string representation

func (CreateLunaClientInput) String added in v0.6.6 

func (s CreateLunaClientInput) String() string

String returns the string representation

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 added in v0.6.6 

func (s CreateLunaClientOutput) GoString() string

GoString returns the string representation

func (CreateLunaClientOutput) String added in v0.6.6 

func (s CreateLunaClientOutput) String() string

String returns the string representation

type DeleteHapgInput added in v0.9.5 

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 added in v0.9.5 

func (s DeleteHapgInput) GoString() string

GoString returns the string representation

func (DeleteHapgInput) String added in v0.9.5 

func (s DeleteHapgInput) String() string

String returns the string representation

type DeleteHapgOutput added in v0.9.5 

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 added in v0.9.5 

func (s DeleteHapgOutput) GoString() string

GoString returns the string representation

func (DeleteHapgOutput) String added in v0.9.5 

func (s DeleteHapgOutput) String() string

String returns the string representation

type DeleteHsmInput added in v0.9.5 

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 added in v0.9.5 

func (s DeleteHsmInput) GoString() string

GoString returns the string representation

func (DeleteHsmInput) String added in v0.9.5 

func (s DeleteHsmInput) String() string

String returns the string representation

type DeleteHsmOutput added in v0.9.5 

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 added in v0.9.5 

func (s DeleteHsmOutput) GoString() string

GoString returns the string representation

func (DeleteHsmOutput) String added in v0.9.5 

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 added in v0.6.6 

func (s DeleteLunaClientInput) GoString() string

GoString returns the string representation

func (DeleteLunaClientInput) String added in v0.6.6 

func (s DeleteLunaClientInput) String() string

String returns the string representation

type DeleteLunaClientOutput 

type DeleteLunaClientOutput struct {

	// The status of the action.
	Status *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLunaClientOutput) GoString added in v0.6.6 

func (s DeleteLunaClientOutput) GoString() string

GoString returns the string representation

func (DeleteLunaClientOutput) String added in v0.6.6 

func (s DeleteLunaClientOutput) String() string

String returns the string representation

type DescribeHapgInput added in v0.9.5 

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 added in v0.9.5 

func (s DescribeHapgInput) GoString() string

GoString returns the string representation

func (DescribeHapgInput) String added in v0.9.5 

func (s DescribeHapgInput) String() string

String returns the string representation

type DescribeHapgOutput added in v0.9.5 

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 added in v0.9.5 

func (s DescribeHapgOutput) GoString() string

GoString returns the string representation

func (DescribeHapgOutput) String added in v0.9.5 

func (s DescribeHapgOutput) String() string

String returns the string representation

type DescribeHsmInput added in v0.9.5 

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 added in v0.9.5 

func (s DescribeHsmInput) GoString() string

GoString returns the string representation

func (DescribeHsmInput) String added in v0.9.5 

func (s DescribeHsmInput) String() string

String returns the string representation

type DescribeHsmOutput added in v0.9.5 

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 added in v0.9.5 

func (s DescribeHsmOutput) GoString() string

GoString returns the string representation

func (DescribeHsmOutput) String added in v0.9.5 

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 added in v0.6.6 

func (s DescribeLunaClientInput) GoString() string

GoString returns the string representation

func (DescribeLunaClientInput) String added in v0.6.6 

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 added in v0.6.6 

func (s DescribeLunaClientOutput) GoString() string

GoString returns the string representation

func (DescribeLunaClientOutput) String added in v0.6.6 

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 added in v0.6.6 

func (s GetConfigInput) GoString() string

GoString returns the string representation

func (GetConfigInput) String added in v0.6.6 

func (s GetConfigInput) String() string

String returns the string representation

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 added in v0.6.6 

func (s GetConfigOutput) GoString() string

GoString returns the string representation

func (GetConfigOutput) String added in v0.6.6 

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 added in v0.6.6 

func (s ListAvailableZonesInput) GoString() string

GoString returns the string representation

func (ListAvailableZonesInput) String added in v0.6.6 

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 added in v0.6.6 

func (s ListAvailableZonesOutput) GoString() string

GoString returns the string representation

func (ListAvailableZonesOutput) String added in v0.6.6 

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 added in v0.6.6 

func (s ListHapgsInput) GoString() string

GoString returns the string representation

func (ListHapgsInput) String added in v0.6.6 

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 added in v0.6.6 

func (s ListHapgsOutput) GoString() string

GoString returns the string representation

func (ListHapgsOutput) String added in v0.6.6 

func (s ListHapgsOutput) String() string

String returns the string representation

type ListHsmsInput added in v0.9.5 

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 added in v0.9.5 

func (s ListHsmsInput) GoString() string

GoString returns the string representation

func (ListHsmsInput) String added in v0.9.5 

func (s ListHsmsInput) String() string

String returns the string representation

type ListHsmsOutput added in v0.9.5 

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 added in v0.9.5 

func (s ListHsmsOutput) GoString() string

GoString returns the string representation

func (ListHsmsOutput) String added in v0.9.5 

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 added in v0.6.6 

func (s ListLunaClientsInput) GoString() string

GoString returns the string representation

func (ListLunaClientsInput) String added in v0.6.6 

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 added in v0.6.6 

func (s ListLunaClientsOutput) GoString() string

GoString returns the string representation

func (ListLunaClientsOutput) String added in v0.6.6 

func (s ListLunaClientsOutput) String() string

String returns the string representation

type ModifyHapgInput added in v0.9.5 

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 added in v0.9.5 

func (s ModifyHapgInput) GoString() string

GoString returns the string representation

func (ModifyHapgInput) String added in v0.9.5 

func (s ModifyHapgInput) String() string

String returns the string representation

type ModifyHapgOutput added in v0.9.5 

type ModifyHapgOutput struct {

	// The ARN of the high-availability partition group.
	HapgArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyHapgOutput) GoString added in v0.9.5 

func (s ModifyHapgOutput) GoString() string

GoString returns the string representation

func (ModifyHapgOutput) String added in v0.9.5 

func (s ModifyHapgOutput) String() string

String returns the string representation

type ModifyHsmInput added in v0.9.5 

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 added in v0.9.5 

func (s ModifyHsmInput) GoString() string

GoString returns the string representation

func (ModifyHsmInput) String added in v0.9.5 

func (s ModifyHsmInput) String() string

String returns the string representation

type ModifyHsmOutput added in v0.9.5 

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 added in v0.9.5 

func (s ModifyHsmOutput) GoString() string

GoString returns the string representation

func (ModifyHsmOutput) String added in v0.9.5 

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 added in v0.6.6 

func (s ModifyLunaClientInput) GoString() string

GoString returns the string representation

func (ModifyLunaClientInput) String added in v0.6.6 

func (s ModifyLunaClientInput) String() string

String returns the string representation

type ModifyLunaClientOutput 

type ModifyLunaClientOutput struct {

	// The ARN of the client.
	ClientArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (ModifyLunaClientOutput) GoString added in v0.6.6 

func (s ModifyLunaClientOutput) GoString() string

GoString returns the string representation

func (ModifyLunaClientOutput) String added in v0.6.6 

func (s ModifyLunaClientOutput) String() string

String returns the string representation

Source Files

View all Source files

Directories

Path Synopsis
Package cloudhsmiface provides an interface for the Amazon CloudHSM.
 Package cloudhsmiface provides an interface for the Amazon CloudHSM.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.