cloudhsmv2

package
v0.17.0 Latest Latest
Warning

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

Go to latest
Published: Nov 21, 2019 License: Apache-2.0 Imports: 7 Imported by: 39

Documentation

Overview

Package cloudhsmv2 provides the client and types for making API requests to CloudHSM V2.

For more information about AWS CloudHSM, see AWS CloudHSM (http://aws.amazon.com/cloudhsm/) and the AWS CloudHSM User Guide (http://docs.aws.amazon.com/cloudhsm/latest/userguide/).

See https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28 for more information on this service.

See cloudhsmv2 package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudhsmv2/

Using the Client

To use CloudHSM V2 with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the CloudHSM V2 client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/cloudhsmv2/#New

Index

Constants

View Source
const (
	ServiceName = "CloudHSM V2" // Service's name
	ServiceID   = "CloudHSMV2"  // Service's identifier
	EndpointsID = "cloudhsmv2"  // Service's Endpoint identifier
)
View Source
const (

	// ErrCodeCloudHsmAccessDeniedException for service response error code
	// "CloudHsmAccessDeniedException".
	//
	// The request was rejected because the requester does not have permission to
	// perform the requested operation.
	ErrCodeCloudHsmAccessDeniedException = "CloudHsmAccessDeniedException"

	// ErrCodeCloudHsmInternalFailureException for service response error code
	// "CloudHsmInternalFailureException".
	//
	// The request was rejected because of an AWS CloudHSM internal failure. The
	// request can be retried.
	ErrCodeCloudHsmInternalFailureException = "CloudHsmInternalFailureException"

	// ErrCodeCloudHsmInvalidRequestException for service response error code
	// "CloudHsmInvalidRequestException".
	//
	// The request was rejected because it is not a valid request.
	ErrCodeCloudHsmInvalidRequestException = "CloudHsmInvalidRequestException"

	// ErrCodeCloudHsmResourceNotFoundException for service response error code
	// "CloudHsmResourceNotFoundException".
	//
	// The request was rejected because it refers to a resource that cannot be found.
	ErrCodeCloudHsmResourceNotFoundException = "CloudHsmResourceNotFoundException"

	// ErrCodeCloudHsmServiceException for service response error code
	// "CloudHsmServiceException".
	//
	// The request was rejected because an error occurred.
	ErrCodeCloudHsmServiceException = "CloudHsmServiceException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Backup

type Backup struct {

	// The identifier (ID) of the backup.
	//
	// BackupId is a required field
	BackupId *string `type:"string" required:"true"`

	// The state of the backup.
	BackupState BackupState `type:"string" enum:"true"`

	// The identifier (ID) of the cluster that was backed up.
	ClusterId *string `type:"string"`

	CopyTimestamp *time.Time `type:"timestamp"`

	// The date and time when the backup was created.
	CreateTimestamp *time.Time `type:"timestamp"`

	// The date and time when the backup will be permanently deleted.
	DeleteTimestamp *time.Time `type:"timestamp"`

	SourceBackup *string `type:"string"`

	SourceCluster *string `type:"string"`

	SourceRegion *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a backup of an AWS CloudHSM cluster.

func (Backup) String

func (s Backup) String() string

String returns the string representation

type BackupPolicy

type BackupPolicy string
const (
	BackupPolicyDefault BackupPolicy = "DEFAULT"
)

Enum values for BackupPolicy

func (BackupPolicy) MarshalValue added in v0.3.0

func (enum BackupPolicy) MarshalValue() (string, error)

func (BackupPolicy) MarshalValueBuf added in v0.3.0

func (enum BackupPolicy) MarshalValueBuf(b []byte) ([]byte, error)

type BackupState

type BackupState string
const (
	BackupStateCreateInProgress BackupState = "CREATE_IN_PROGRESS"
	BackupStateReady            BackupState = "READY"
	BackupStateDeleted          BackupState = "DELETED"
	BackupStatePendingDeletion  BackupState = "PENDING_DELETION"
)

Enum values for BackupState

func (BackupState) MarshalValue added in v0.3.0

func (enum BackupState) MarshalValue() (string, error)

func (BackupState) MarshalValueBuf added in v0.3.0

func (enum BackupState) MarshalValueBuf(b []byte) ([]byte, error)

type Certificates

type Certificates struct {

	// The HSM hardware certificate issued (signed) by AWS CloudHSM.
	AwsHardwareCertificate *string `type:"string"`

	// The cluster certificate issued (signed) by the issuing certificate authority
	// (CA) of the cluster's owner.
	ClusterCertificate *string `type:"string"`

	// The cluster's certificate signing request (CSR). The CSR exists only when
	// the cluster's state is UNINITIALIZED.
	ClusterCsr *string `type:"string"`

	// The HSM certificate issued (signed) by the HSM hardware.
	HsmCertificate *string `type:"string"`

	// The HSM hardware certificate issued (signed) by the hardware manufacturer.
	ManufacturerHardwareCertificate *string `type:"string"`
	// contains filtered or unexported fields
}

Contains one or more certificates or a certificate signing request (CSR).

func (Certificates) String

func (s Certificates) String() string

String returns the string representation

type Client added in v0.9.0

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to CloudHSM V2. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example:

// Create a client from just a config.
svc := cloudhsmv2.New(myConfig)

func (*Client) CopyBackupToRegionRequest added in v0.9.0

func (c *Client) CopyBackupToRegionRequest(input *CopyBackupToRegionInput) CopyBackupToRegionRequest

CopyBackupToRegionRequest returns a request value for making API operation for AWS CloudHSM V2.

Copy an AWS CloudHSM cluster backup to a different region.

// Example sending a request using CopyBackupToRegionRequest.
req := client.CopyBackupToRegionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CopyBackupToRegion

func (*Client) CreateClusterRequest added in v0.9.0

func (c *Client) CreateClusterRequest(input *CreateClusterInput) CreateClusterRequest

CreateClusterRequest returns a request value for making API operation for AWS CloudHSM V2.

Creates a new AWS CloudHSM cluster.

// Example sending a request using CreateClusterRequest.
req := client.CreateClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateCluster

func (*Client) CreateHsmRequest added in v0.9.0

func (c *Client) CreateHsmRequest(input *CreateHsmInput) CreateHsmRequest

CreateHsmRequest returns a request value for making API operation for AWS CloudHSM V2.

Creates a new hardware security module (HSM) in the specified AWS CloudHSM cluster.

// Example sending a request using CreateHsmRequest.
req := client.CreateHsmRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/CreateHsm

func (*Client) DeleteBackupRequest added in v0.9.0

func (c *Client) DeleteBackupRequest(input *DeleteBackupInput) DeleteBackupRequest

DeleteBackupRequest returns a request value for making API operation for AWS CloudHSM V2.

Deletes a specified AWS CloudHSM backup. A backup can be restored up to 7 days after the DeleteBackup request. For more information on restoring a backup, see RestoreBackup

// Example sending a request using DeleteBackupRequest.
req := client.DeleteBackupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteBackup

func (*Client) DeleteClusterRequest added in v0.9.0

func (c *Client) DeleteClusterRequest(input *DeleteClusterInput) DeleteClusterRequest

DeleteClusterRequest returns a request value for making API operation for AWS CloudHSM V2.

Deletes the specified AWS CloudHSM cluster. Before you can delete a cluster, you must delete all HSMs in the cluster. To see if the cluster contains any HSMs, use DescribeClusters. To delete an HSM, use DeleteHsm.

// Example sending a request using DeleteClusterRequest.
req := client.DeleteClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteCluster

func (*Client) DeleteHsmRequest added in v0.9.0

func (c *Client) DeleteHsmRequest(input *DeleteHsmInput) DeleteHsmRequest

DeleteHsmRequest returns a request value for making API operation for AWS CloudHSM V2.

Deletes the specified HSM. To specify an HSM, you can use its identifier (ID), the IP address of the HSM's elastic network interface (ENI), or the ID of the HSM's ENI. You need to specify only one of these values. To find these values, use DescribeClusters.

// Example sending a request using DeleteHsmRequest.
req := client.DeleteHsmRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DeleteHsm

func (*Client) DescribeBackupsRequest added in v0.9.0

func (c *Client) DescribeBackupsRequest(input *DescribeBackupsInput) DescribeBackupsRequest

DescribeBackupsRequest returns a request value for making API operation for AWS CloudHSM V2.

Gets information about backups of AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the backups. When the response contains only a subset of backups, it includes a NextToken value. Use this value in a subsequent DescribeBackups request to get more backups. When you receive a response with no NextToken (or an empty or null value), that means there are no more backups to get.

// Example sending a request using DescribeBackupsRequest.
req := client.DescribeBackupsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeBackups

func (*Client) DescribeClustersRequest added in v0.9.0

func (c *Client) DescribeClustersRequest(input *DescribeClustersInput) DescribeClustersRequest

DescribeClustersRequest returns a request value for making API operation for AWS CloudHSM V2.

Gets information about AWS CloudHSM clusters.

This is a paginated operation, which means that each response might contain only a subset of all the clusters. When the response contains only a subset of clusters, it includes a NextToken value. Use this value in a subsequent DescribeClusters request to get more clusters. When you receive a response with no NextToken (or an empty or null value), that means there are no more clusters to get.

// Example sending a request using DescribeClustersRequest.
req := client.DescribeClustersRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/DescribeClusters

func (*Client) InitializeClusterRequest added in v0.9.0

func (c *Client) InitializeClusterRequest(input *InitializeClusterInput) InitializeClusterRequest

InitializeClusterRequest returns a request value for making API operation for AWS CloudHSM V2.

Claims an AWS CloudHSM cluster by submitting the cluster certificate issued by your issuing certificate authority (CA) and the CA's root certificate. Before you can claim a cluster, you must sign the cluster's certificate signing request (CSR) with your issuing CA. To get the cluster's CSR, use DescribeClusters.

// Example sending a request using InitializeClusterRequest.
req := client.InitializeClusterRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/InitializeCluster

func (*Client) ListTagsRequest added in v0.9.0

func (c *Client) ListTagsRequest(input *ListTagsInput) ListTagsRequest

ListTagsRequest returns a request value for making API operation for AWS CloudHSM V2.

Gets a list of tags for the specified AWS CloudHSM cluster.

This is a paginated operation, which means that each response might contain only a subset of all the tags. When the response contains only a subset of tags, it includes a NextToken value. Use this value in a subsequent ListTags request to get more tags. When you receive a response with no NextToken (or an empty or null value), that means there are no more tags to get.

// Example sending a request using ListTagsRequest.
req := client.ListTagsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/ListTags

func (*Client) RestoreBackupRequest added in v0.9.0

func (c *Client) RestoreBackupRequest(input *RestoreBackupInput) RestoreBackupRequest

RestoreBackupRequest returns a request value for making API operation for AWS CloudHSM V2.

Restores a specified AWS CloudHSM backup that is in the PENDING_DELETION state. For more information on deleting a backup, see DeleteBackup.

// Example sending a request using RestoreBackupRequest.
req := client.RestoreBackupRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/RestoreBackup

func (*Client) TagResourceRequest added in v0.9.0

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS CloudHSM V2.

Adds or overwrites one or more tags for the specified AWS CloudHSM cluster.

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/TagResource

func (*Client) UntagResourceRequest added in v0.9.0

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS CloudHSM V2.

Removes the specified tag or tags from the specified AWS CloudHSM cluster.

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2-2017-04-28/UntagResource

type Cluster

type Cluster struct {

	// The cluster's backup policy.
	BackupPolicy BackupPolicy `type:"string" enum:"true"`

	// Contains one or more certificates or a certificate signing request (CSR).
	Certificates *Certificates `type:"structure"`

	// The cluster's identifier (ID).
	ClusterId *string `type:"string"`

	// The date and time when the cluster was created.
	CreateTimestamp *time.Time `type:"timestamp"`

	// The type of HSM that the cluster contains.
	HsmType *string `type:"string"`

	// Contains information about the HSMs in the cluster.
	Hsms []Hsm `type:"list"`

	// The default password for the cluster's Pre-Crypto Officer (PRECO) user.
	PreCoPassword *string `min:"7" type:"string"`

	// The identifier (ID) of the cluster's security group.
	SecurityGroup *string `type:"string"`

	// The identifier (ID) of the backup used to create the cluster. This value
	// exists only when the cluster was created from a backup.
	SourceBackupId *string `type:"string"`

	// The cluster's state.
	State ClusterState `type:"string" enum:"true"`

	// A description of the cluster's state.
	StateMessage *string `type:"string"`

	// A map of the cluster's subnets and their corresponding Availability Zones.
	SubnetMapping map[string]string `type:"map"`

	// The identifier (ID) of the virtual private cloud (VPC) that contains the
	// cluster.
	VpcId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about an AWS CloudHSM cluster.

func (Cluster) String

func (s Cluster) String() string

String returns the string representation

type ClusterState

type ClusterState string
const (
	ClusterStateCreateInProgress     ClusterState = "CREATE_IN_PROGRESS"
	ClusterStateUninitialized        ClusterState = "UNINITIALIZED"
	ClusterStateInitializeInProgress ClusterState = "INITIALIZE_IN_PROGRESS"
	ClusterStateInitialized          ClusterState = "INITIALIZED"
	ClusterStateActive               ClusterState = "ACTIVE"
	ClusterStateUpdateInProgress     ClusterState = "UPDATE_IN_PROGRESS"
	ClusterStateDeleteInProgress     ClusterState = "DELETE_IN_PROGRESS"
	ClusterStateDeleted              ClusterState = "DELETED"
	ClusterStateDegraded             ClusterState = "DEGRADED"
)

Enum values for ClusterState

func (ClusterState) MarshalValue added in v0.3.0

func (enum ClusterState) MarshalValue() (string, error)

func (ClusterState) MarshalValueBuf added in v0.3.0

func (enum ClusterState) MarshalValueBuf(b []byte) ([]byte, error)

type CopyBackupToRegionInput added in v0.5.0

type CopyBackupToRegionInput struct {

	// The ID of the backup that will be copied to the destination region.
	//
	// BackupId is a required field
	BackupId *string `type:"string" required:"true"`

	// The AWS region that will contain your copied CloudHSM cluster backup.
	//
	// DestinationRegion is a required field
	DestinationRegion *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CopyBackupToRegionInput) String added in v0.5.0

func (s CopyBackupToRegionInput) String() string

String returns the string representation

func (*CopyBackupToRegionInput) Validate added in v0.5.0

func (s *CopyBackupToRegionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopyBackupToRegionOutput added in v0.5.0

type CopyBackupToRegionOutput struct {

	// Information on the backup that will be copied to the destination region,
	// including CreateTimestamp, SourceBackup, SourceCluster, and Source Region.
	// CreateTimestamp of the destination backup will be the same as that of the
	// source backup.
	//
	// You will need to use the sourceBackupID returned in this operation to use
	// the DescribeBackups operation on the backup that will be copied to the destination
	// region.
	DestinationBackup *DestinationBackup `type:"structure"`
	// contains filtered or unexported fields
}

func (CopyBackupToRegionOutput) String added in v0.5.0

func (s CopyBackupToRegionOutput) String() string

String returns the string representation

type CopyBackupToRegionRequest added in v0.5.0

type CopyBackupToRegionRequest struct {
	*aws.Request
	Input *CopyBackupToRegionInput
	Copy  func(*CopyBackupToRegionInput) CopyBackupToRegionRequest
}

CopyBackupToRegionRequest is the request type for the CopyBackupToRegion API operation.

func (CopyBackupToRegionRequest) Send added in v0.5.0

Send marshals and sends the CopyBackupToRegion API request.

type CopyBackupToRegionResponse added in v0.9.0

type CopyBackupToRegionResponse struct {
	*CopyBackupToRegionOutput
	// contains filtered or unexported fields
}

CopyBackupToRegionResponse is the response type for the CopyBackupToRegion API operation.

func (*CopyBackupToRegionResponse) SDKResponseMetdata added in v0.9.0

func (r *CopyBackupToRegionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CopyBackupToRegion request.

type CreateClusterInput

type CreateClusterInput struct {

	// The type of HSM to use in the cluster. Currently the only allowed value is
	// hsm1.medium.
	//
	// HsmType is a required field
	HsmType *string `type:"string" required:"true"`

	// The identifier (ID) of the cluster backup to restore. Use this value to restore
	// the cluster from a backup instead of creating a new cluster. To find the
	// backup ID, use DescribeBackups.
	SourceBackupId *string `type:"string"`

	// The identifiers (IDs) of the subnets where you are creating the cluster.
	// You must specify at least one subnet. If you specify multiple subnets, they
	// must meet the following criteria:
	//
	//    * All subnets must be in the same virtual private cloud (VPC).
	//
	//    * You can specify only one subnet per Availability Zone.
	//
	// SubnetIds is a required field
	SubnetIds []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (CreateClusterInput) String

func (s CreateClusterInput) String() string

String returns the string representation

func (*CreateClusterInput) Validate

func (s *CreateClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateClusterOutput

type CreateClusterOutput struct {

	// Information about the cluster that was created.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateClusterOutput) String

func (s CreateClusterOutput) String() string

String returns the string representation

type CreateClusterRequest

type CreateClusterRequest struct {
	*aws.Request
	Input *CreateClusterInput
	Copy  func(*CreateClusterInput) CreateClusterRequest
}

CreateClusterRequest is the request type for the CreateCluster API operation.

func (CreateClusterRequest) Send

Send marshals and sends the CreateCluster API request.

type CreateClusterResponse added in v0.9.0

type CreateClusterResponse struct {
	*CreateClusterOutput
	// contains filtered or unexported fields
}

CreateClusterResponse is the response type for the CreateCluster API operation.

func (*CreateClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateCluster request.

type CreateHsmInput

type CreateHsmInput struct {

	// The Availability Zone where you are creating the HSM. To find the cluster's
	// Availability Zones, use DescribeClusters.
	//
	// AvailabilityZone is a required field
	AvailabilityZone *string `type:"string" required:"true"`

	// The identifier (ID) of the HSM's cluster. To find the cluster ID, use DescribeClusters.
	//
	// ClusterId is a required field
	ClusterId *string `type:"string" required:"true"`

	// The HSM's IP address. If you specify an IP address, use an available address
	// from the subnet that maps to the Availability Zone where you are creating
	// the HSM. If you don't specify an IP address, one is chosen for you from that
	// subnet.
	IpAddress *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateHsmInput) String

func (s CreateHsmInput) String() string

String returns the string representation

func (*CreateHsmInput) Validate

func (s *CreateHsmInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateHsmOutput

type CreateHsmOutput struct {

	// Information about the HSM that was created.
	Hsm *Hsm `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateHsmOutput) String

func (s CreateHsmOutput) String() string

String returns the string representation

type CreateHsmRequest

type CreateHsmRequest struct {
	*aws.Request
	Input *CreateHsmInput
	Copy  func(*CreateHsmInput) CreateHsmRequest
}

CreateHsmRequest is the request type for the CreateHsm API operation.

func (CreateHsmRequest) Send

Send marshals and sends the CreateHsm API request.

type CreateHsmResponse added in v0.9.0

type CreateHsmResponse struct {
	*CreateHsmOutput
	// contains filtered or unexported fields
}

CreateHsmResponse is the response type for the CreateHsm API operation.

func (*CreateHsmResponse) SDKResponseMetdata added in v0.9.0

func (r *CreateHsmResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateHsm request.

type DeleteBackupInput added in v0.5.0

type DeleteBackupInput struct {

	// The ID of the backup to be deleted. To find the ID of a backup, use the DescribeBackups
	// operation.
	//
	// BackupId is a required field
	BackupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBackupInput) String added in v0.5.0

func (s DeleteBackupInput) String() string

String returns the string representation

func (*DeleteBackupInput) Validate added in v0.5.0

func (s *DeleteBackupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupOutput added in v0.5.0

type DeleteBackupOutput struct {

	// Information on the Backup object deleted.
	Backup *Backup `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteBackupOutput) String added in v0.5.0

func (s DeleteBackupOutput) String() string

String returns the string representation

type DeleteBackupRequest added in v0.5.0

type DeleteBackupRequest struct {
	*aws.Request
	Input *DeleteBackupInput
	Copy  func(*DeleteBackupInput) DeleteBackupRequest
}

DeleteBackupRequest is the request type for the DeleteBackup API operation.

func (DeleteBackupRequest) Send added in v0.5.0

Send marshals and sends the DeleteBackup API request.

type DeleteBackupResponse added in v0.9.0

type DeleteBackupResponse struct {
	*DeleteBackupOutput
	// contains filtered or unexported fields
}

DeleteBackupResponse is the response type for the DeleteBackup API operation.

func (*DeleteBackupResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteBackup request.

type DeleteClusterInput

type DeleteClusterInput struct {

	// The identifier (ID) of the cluster that you are deleting. To find the cluster
	// ID, use DescribeClusters.
	//
	// ClusterId is a required field
	ClusterId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteClusterInput) String

func (s DeleteClusterInput) String() string

String returns the string representation

func (*DeleteClusterInput) Validate

func (s *DeleteClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteClusterOutput

type DeleteClusterOutput struct {

	// Information about the cluster that was deleted.
	Cluster *Cluster `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteClusterOutput) String

func (s DeleteClusterOutput) String() string

String returns the string representation

type DeleteClusterRequest

type DeleteClusterRequest struct {
	*aws.Request
	Input *DeleteClusterInput
	Copy  func(*DeleteClusterInput) DeleteClusterRequest
}

DeleteClusterRequest is the request type for the DeleteCluster API operation.

func (DeleteClusterRequest) Send

Send marshals and sends the DeleteCluster API request.

type DeleteClusterResponse added in v0.9.0

type DeleteClusterResponse struct {
	*DeleteClusterOutput
	// contains filtered or unexported fields
}

DeleteClusterResponse is the response type for the DeleteCluster API operation.

func (*DeleteClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteCluster request.

type DeleteHsmInput

type DeleteHsmInput struct {

	// The identifier (ID) of the cluster that contains the HSM that you are deleting.
	//
	// ClusterId is a required field
	ClusterId *string `type:"string" required:"true"`

	// The identifier (ID) of the elastic network interface (ENI) of the HSM that
	// you are deleting.
	EniId *string `type:"string"`

	// The IP address of the elastic network interface (ENI) of the HSM that you
	// are deleting.
	EniIp *string `type:"string"`

	// The identifier (ID) of the HSM that you are deleting.
	HsmId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteHsmInput) String

func (s DeleteHsmInput) String() string

String returns the string representation

func (*DeleteHsmInput) Validate

func (s *DeleteHsmInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteHsmOutput

type DeleteHsmOutput struct {

	// The identifier (ID) of the HSM that was deleted.
	HsmId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteHsmOutput) String

func (s DeleteHsmOutput) String() string

String returns the string representation

type DeleteHsmRequest

type DeleteHsmRequest struct {
	*aws.Request
	Input *DeleteHsmInput
	Copy  func(*DeleteHsmInput) DeleteHsmRequest
}

DeleteHsmRequest is the request type for the DeleteHsm API operation.

func (DeleteHsmRequest) Send

Send marshals and sends the DeleteHsm API request.

type DeleteHsmResponse added in v0.9.0

type DeleteHsmResponse struct {
	*DeleteHsmOutput
	// contains filtered or unexported fields
}

DeleteHsmResponse is the response type for the DeleteHsm API operation.

func (*DeleteHsmResponse) SDKResponseMetdata added in v0.9.0

func (r *DeleteHsmResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteHsm request.

type DescribeBackupsInput

type DescribeBackupsInput struct {

	// One or more filters to limit the items returned in the response.
	//
	// Use the backupIds filter to return only the specified backups. Specify backups
	// by their backup identifier (ID).
	//
	// Use the sourceBackupIds filter to return only the backups created from a
	// source backup. The sourceBackupID of a source backup is returned by the CopyBackupToRegion
	// operation.
	//
	// Use the clusterIds filter to return only the backups for the specified clusters.
	// Specify clusters by their cluster identifier (ID).
	//
	// Use the states filter to return only backups that match the specified state.
	Filters map[string][]string `type:"map"`

	// The maximum number of backups to return in the response. When there are more
	// backups than the number you specify, the response contains a NextToken value.
	MaxResults *int64 `min:"1" type:"integer"`

	// The NextToken value that you received in the previous response. Use this
	// value to get more backups.
	NextToken *string `type:"string"`

	SortAscending *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (DescribeBackupsInput) String

func (s DescribeBackupsInput) String() string

String returns the string representation

func (*DescribeBackupsInput) Validate

func (s *DescribeBackupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBackupsOutput

type DescribeBackupsOutput struct {

	// A list of backups.
	Backups []Backup `type:"list"`

	// An opaque string that indicates that the response contains only a subset
	// of backups. Use this value in a subsequent DescribeBackups request to get
	// more backups.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeBackupsOutput) String

func (s DescribeBackupsOutput) String() string

String returns the string representation

type DescribeBackupsPaginator added in v0.9.0

type DescribeBackupsPaginator struct {
	aws.Pager
}

DescribeBackupsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeBackupsPaginator added in v0.9.0

func NewDescribeBackupsPaginator(req DescribeBackupsRequest) DescribeBackupsPaginator

NewDescribeBackupsRequestPaginator returns a paginator for DescribeBackups. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeBackupsRequest(input)
p := cloudhsmv2.NewDescribeBackupsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeBackupsPaginator) CurrentPage added in v0.9.0

type DescribeBackupsRequest

type DescribeBackupsRequest struct {
	*aws.Request
	Input *DescribeBackupsInput
	Copy  func(*DescribeBackupsInput) DescribeBackupsRequest
}

DescribeBackupsRequest is the request type for the DescribeBackups API operation.

func (DescribeBackupsRequest) Send

Send marshals and sends the DescribeBackups API request.

type DescribeBackupsResponse added in v0.9.0

type DescribeBackupsResponse struct {
	*DescribeBackupsOutput
	// contains filtered or unexported fields
}

DescribeBackupsResponse is the response type for the DescribeBackups API operation.

func (*DescribeBackupsResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeBackupsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeBackups request.

type DescribeClustersInput

type DescribeClustersInput struct {

	// One or more filters to limit the items returned in the response.
	//
	// Use the clusterIds filter to return only the specified clusters. Specify
	// clusters by their cluster identifier (ID).
	//
	// Use the vpcIds filter to return only the clusters in the specified virtual
	// private clouds (VPCs). Specify VPCs by their VPC identifier (ID).
	//
	// Use the states filter to return only clusters that match the specified state.
	Filters map[string][]string `type:"map"`

	// The maximum number of clusters to return in the response. When there are
	// more clusters than the number you specify, the response contains a NextToken
	// value.
	MaxResults *int64 `min:"1" type:"integer"`

	// The NextToken value that you received in the previous response. Use this
	// value to get more clusters.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeClustersInput) String

func (s DescribeClustersInput) String() string

String returns the string representation

func (*DescribeClustersInput) Validate

func (s *DescribeClustersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeClustersOutput

type DescribeClustersOutput struct {

	// A list of clusters.
	Clusters []Cluster `type:"list"`

	// An opaque string that indicates that the response contains only a subset
	// of clusters. Use this value in a subsequent DescribeClusters request to get
	// more clusters.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeClustersOutput) String

func (s DescribeClustersOutput) String() string

String returns the string representation

type DescribeClustersPaginator added in v0.9.0

type DescribeClustersPaginator struct {
	aws.Pager
}

DescribeClustersPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewDescribeClustersPaginator added in v0.9.0

func NewDescribeClustersPaginator(req DescribeClustersRequest) DescribeClustersPaginator

NewDescribeClustersRequestPaginator returns a paginator for DescribeClusters. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.DescribeClustersRequest(input)
p := cloudhsmv2.NewDescribeClustersRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*DescribeClustersPaginator) CurrentPage added in v0.9.0

type DescribeClustersRequest

type DescribeClustersRequest struct {
	*aws.Request
	Input *DescribeClustersInput
	Copy  func(*DescribeClustersInput) DescribeClustersRequest
}

DescribeClustersRequest is the request type for the DescribeClusters API operation.

func (DescribeClustersRequest) Send

Send marshals and sends the DescribeClusters API request.

type DescribeClustersResponse added in v0.9.0

type DescribeClustersResponse struct {
	*DescribeClustersOutput
	// contains filtered or unexported fields
}

DescribeClustersResponse is the response type for the DescribeClusters API operation.

func (*DescribeClustersResponse) SDKResponseMetdata added in v0.9.0

func (r *DescribeClustersResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeClusters request.

type DestinationBackup added in v0.5.0

type DestinationBackup struct {
	CreateTimestamp *time.Time `type:"timestamp"`

	SourceBackup *string `type:"string"`

	SourceCluster *string `type:"string"`

	SourceRegion *string `type:"string"`
	// contains filtered or unexported fields
}

func (DestinationBackup) String added in v0.5.0

func (s DestinationBackup) String() string

String returns the string representation

type Hsm

type Hsm struct {

	// The Availability Zone that contains the HSM.
	AvailabilityZone *string `type:"string"`

	// The identifier (ID) of the cluster that contains the HSM.
	ClusterId *string `type:"string"`

	// The identifier (ID) of the HSM's elastic network interface (ENI).
	EniId *string `type:"string"`

	// The IP address of the HSM's elastic network interface (ENI).
	EniIp *string `type:"string"`

	// The HSM's identifier (ID).
	//
	// HsmId is a required field
	HsmId *string `type:"string" required:"true"`

	// The HSM's state.
	State HsmState `type:"string" enum:"true"`

	// A description of the HSM's state.
	StateMessage *string `type:"string"`

	// The subnet that contains the HSM's elastic network interface (ENI).
	SubnetId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information about a hardware security module (HSM) in an AWS CloudHSM cluster.

func (Hsm) String

func (s Hsm) String() string

String returns the string representation

type HsmState

type HsmState string
const (
	HsmStateCreateInProgress HsmState = "CREATE_IN_PROGRESS"
	HsmStateActive           HsmState = "ACTIVE"
	HsmStateDegraded         HsmState = "DEGRADED"
	HsmStateDeleteInProgress HsmState = "DELETE_IN_PROGRESS"
	HsmStateDeleted          HsmState = "DELETED"
)

Enum values for HsmState

func (HsmState) MarshalValue added in v0.3.0

func (enum HsmState) MarshalValue() (string, error)

func (HsmState) MarshalValueBuf added in v0.3.0

func (enum HsmState) MarshalValueBuf(b []byte) ([]byte, error)

type InitializeClusterInput

type InitializeClusterInput struct {

	// The identifier (ID) of the cluster that you are claiming. To find the cluster
	// ID, use DescribeClusters.
	//
	// ClusterId is a required field
	ClusterId *string `type:"string" required:"true"`

	// The cluster certificate issued (signed) by your issuing certificate authority
	// (CA). The certificate must be in PEM format and can contain a maximum of
	// 5000 characters.
	//
	// SignedCert is a required field
	SignedCert *string `type:"string" required:"true"`

	// The issuing certificate of the issuing certificate authority (CA) that issued
	// (signed) the cluster certificate. This can be a root (self-signed) certificate
	// or a certificate chain that begins with the certificate that issued the cluster
	// certificate and ends with a root certificate. The certificate or certificate
	// chain must be in PEM format and can contain a maximum of 5000 characters.
	//
	// TrustAnchor is a required field
	TrustAnchor *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (InitializeClusterInput) String

func (s InitializeClusterInput) String() string

String returns the string representation

func (*InitializeClusterInput) Validate

func (s *InitializeClusterInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InitializeClusterOutput

type InitializeClusterOutput struct {

	// The cluster's state.
	State ClusterState `type:"string" enum:"true"`

	// A description of the cluster's state.
	StateMessage *string `type:"string"`
	// contains filtered or unexported fields
}

func (InitializeClusterOutput) String

func (s InitializeClusterOutput) String() string

String returns the string representation

type InitializeClusterRequest

type InitializeClusterRequest struct {
	*aws.Request
	Input *InitializeClusterInput
	Copy  func(*InitializeClusterInput) InitializeClusterRequest
}

InitializeClusterRequest is the request type for the InitializeCluster API operation.

func (InitializeClusterRequest) Send

Send marshals and sends the InitializeCluster API request.

type InitializeClusterResponse added in v0.9.0

type InitializeClusterResponse struct {
	*InitializeClusterOutput
	// contains filtered or unexported fields
}

InitializeClusterResponse is the response type for the InitializeCluster API operation.

func (*InitializeClusterResponse) SDKResponseMetdata added in v0.9.0

func (r *InitializeClusterResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the InitializeCluster request.

type ListTagsInput

type ListTagsInput struct {

	// The maximum number of tags to return in the response. When there are more
	// tags than the number you specify, the response contains a NextToken value.
	MaxResults *int64 `min:"1" type:"integer"`

	// The NextToken value that you received in the previous response. Use this
	// value to get more tags.
	NextToken *string `type:"string"`

	// The cluster identifier (ID) for the cluster whose tags you are getting. To
	// find the cluster ID, use DescribeClusters.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsInput) String

func (s ListTagsInput) String() string

String returns the string representation

func (*ListTagsInput) Validate

func (s *ListTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsOutput

type ListTagsOutput struct {

	// An opaque string that indicates that the response contains only a subset
	// of tags. Use this value in a subsequent ListTags request to get more tags.
	NextToken *string `type:"string"`

	// A list of tags.
	//
	// TagList is a required field
	TagList []Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsOutput) String

func (s ListTagsOutput) String() string

String returns the string representation

type ListTagsPaginator added in v0.9.0

type ListTagsPaginator struct {
	aws.Pager
}

ListTagsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTagsPaginator added in v0.9.0

func NewListTagsPaginator(req ListTagsRequest) ListTagsPaginator

NewListTagsRequestPaginator returns a paginator for ListTags. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service.

// Example iterating over pages.
req := client.ListTagsRequest(input)
p := cloudhsmv2.NewListTagsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTagsPaginator) CurrentPage added in v0.9.0

func (p *ListTagsPaginator) CurrentPage() *ListTagsOutput

type ListTagsRequest

type ListTagsRequest struct {
	*aws.Request
	Input *ListTagsInput
	Copy  func(*ListTagsInput) ListTagsRequest
}

ListTagsRequest is the request type for the ListTags API operation.

func (ListTagsRequest) Send

Send marshals and sends the ListTags API request.

type ListTagsResponse added in v0.9.0

type ListTagsResponse struct {
	*ListTagsOutput
	// contains filtered or unexported fields
}

ListTagsResponse is the response type for the ListTags API operation.

func (*ListTagsResponse) SDKResponseMetdata added in v0.9.0

func (r *ListTagsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTags request.

type RestoreBackupInput added in v0.5.0

type RestoreBackupInput struct {

	// The ID of the backup to be restored. To find the ID of a backup, use the
	// DescribeBackups operation.
	//
	// BackupId is a required field
	BackupId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (RestoreBackupInput) String added in v0.5.0

func (s RestoreBackupInput) String() string

String returns the string representation

func (*RestoreBackupInput) Validate added in v0.5.0

func (s *RestoreBackupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RestoreBackupOutput added in v0.5.0

type RestoreBackupOutput struct {

	// Information on the Backup object created.
	Backup *Backup `type:"structure"`
	// contains filtered or unexported fields
}

func (RestoreBackupOutput) String added in v0.5.0

func (s RestoreBackupOutput) String() string

String returns the string representation

type RestoreBackupRequest added in v0.5.0

type RestoreBackupRequest struct {
	*aws.Request
	Input *RestoreBackupInput
	Copy  func(*RestoreBackupInput) RestoreBackupRequest
}

RestoreBackupRequest is the request type for the RestoreBackup API operation.

func (RestoreBackupRequest) Send added in v0.5.0

Send marshals and sends the RestoreBackup API request.

type RestoreBackupResponse added in v0.9.0

type RestoreBackupResponse struct {
	*RestoreBackupOutput
	// contains filtered or unexported fields
}

RestoreBackupResponse is the response type for the RestoreBackup API operation.

func (*RestoreBackupResponse) SDKResponseMetdata added in v0.9.0

func (r *RestoreBackupResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the RestoreBackup request.

type Tag

type Tag struct {

	// The key of the tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value of the tag.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains a tag. A tag is a key-value pair.

func (Tag) String

func (s Tag) String() string

String returns the string representation

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput

type TagResourceInput struct {

	// The cluster identifier (ID) for the cluster that you are tagging. To find
	// the cluster ID, use DescribeClusters.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// A list of one or more tags.
	//
	// TagList is a required field
	TagList []Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

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

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type UntagResourceInput

type UntagResourceInput struct {

	// The cluster identifier (ID) for the cluster whose tags you are removing.
	// To find the cluster ID, use DescribeClusters.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// A list of one or more tag keys for the tags that you are removing. Specify
	// only the tag keys, not the tag values.
	//
	// TagKeyList is a required field
	TagKeyList []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

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

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

Directories

Path Synopsis
Package cloudhsmv2iface provides an interface to enable mocking the AWS CloudHSM V2 service client for testing your code.
Package cloudhsmv2iface provides an interface to enable mocking the AWS CloudHSM V2 service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL