CloudHSMV2

public struct CloudHSMV2

Client object for interacting with AWS CloudHSMV2 service.

For more information about AWS CloudHSM, see AWS CloudHSM and the AWS CloudHSM User Guide.

Member variables

Initialization

  • Initialize the CloudHSMV2 client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • Copy an AWS CloudHSM cluster backup to a different region.

    Declaration

    Swift

    public func copyBackupToRegion(_ input: CopyBackupToRegionRequest) -> EventLoopFuture<CopyBackupToRegionResponse>

  • Creates a new AWS CloudHSM cluster.

    Declaration

    Swift

    public func createCluster(_ input: CreateClusterRequest) -> EventLoopFuture<CreateClusterResponse>

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

    Declaration

    Swift

    public func createHsm(_ input: CreateHsmRequest) -> EventLoopFuture<CreateHsmResponse>

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

    Declaration

    Swift

    public func deleteBackup(_ input: DeleteBackupRequest) -> EventLoopFuture<DeleteBackupResponse>

  • 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.

    Declaration

    Swift

    public func deleteCluster(_ input: DeleteClusterRequest) -> EventLoopFuture<DeleteClusterResponse>

  • 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.

    Declaration

    Swift

    public func deleteHsm(_ input: DeleteHsmRequest) -> EventLoopFuture<DeleteHsmResponse>

  • 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.

    Declaration

    Swift

    public func describeBackups(_ input: DescribeBackupsRequest) -> EventLoopFuture<DescribeBackupsResponse>

  • 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.

    Declaration

    Swift

    public func describeClusters(_ input: DescribeClustersRequest) -> EventLoopFuture<DescribeClustersResponse>

  • 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.

    Declaration

    Swift

    public func initializeCluster(_ input: InitializeClusterRequest) -> EventLoopFuture<InitializeClusterResponse>

  • 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.

    Declaration

    Swift

    public func listTags(_ input: ListTagsRequest) -> EventLoopFuture<ListTagsResponse>

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

    Declaration

    Swift

    public func restoreBackup(_ input: RestoreBackupRequest) -> EventLoopFuture<RestoreBackupResponse>

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

    Declaration

    Swift

    public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<TagResourceResponse>

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

    Declaration

    Swift

    public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<UntagResourceResponse>

Paginators

  • 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.

    Declaration

    Swift

    public func describeBackupsPaginator(_ input: DescribeBackupsRequest, onPage: @escaping (DescribeBackupsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func describeClustersPaginator(_ input: DescribeClustersRequest, onPage: @escaping (DescribeClustersResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func listTagsPaginator(_ input: ListTagsRequest, onPage: @escaping (ListTagsResponse, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum BackupPolicy : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum BackupState : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum ClusterState : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum HsmState : String, CustomStringConvertible, Codable