Skip to content

Type definitions#

Index > CloudHSMV2 > Type definitions

Auto-generated documentation for CloudHSMV2 type annotations stubs module types-boto3-cloudhsmv2.

BackupRetentionPolicyTypeDef#

# BackupRetentionPolicyTypeDef definition

class BackupRetentionPolicyTypeDef(TypedDict):
    Type: NotRequired[BackupRetentionTypeType],  # (1)
    Value: NotRequired[str],
  1. See BackupRetentionTypeType

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

CertificatesTypeDef#

# CertificatesTypeDef definition

class CertificatesTypeDef(TypedDict):
    ClusterCsr: NotRequired[str],
    HsmCertificate: NotRequired[str],
    AwsHardwareCertificate: NotRequired[str],
    ManufacturerHardwareCertificate: NotRequired[str],
    ClusterCertificate: NotRequired[str],

HsmTypeDef#

# HsmTypeDef definition

class HsmTypeDef(TypedDict):
    HsmId: str,
    AvailabilityZone: NotRequired[str],
    ClusterId: NotRequired[str],
    SubnetId: NotRequired[str],
    EniId: NotRequired[str],
    EniIp: NotRequired[str],
    EniIpV6: NotRequired[str],
    State: NotRequired[HsmStateType],  # (1)
    StateMessage: NotRequired[str],
  1. See HsmStateType

DestinationBackupTypeDef#

# DestinationBackupTypeDef definition

class DestinationBackupTypeDef(TypedDict):
    CreateTimestamp: NotRequired[datetime],
    SourceRegion: NotRequired[str],
    SourceBackup: NotRequired[str],
    SourceCluster: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

CreateHsmRequestRequestTypeDef#

# CreateHsmRequestRequestTypeDef definition

class CreateHsmRequestRequestTypeDef(TypedDict):
    ClusterId: str,
    AvailabilityZone: str,
    IpAddress: NotRequired[str],

DeleteBackupRequestRequestTypeDef#

# DeleteBackupRequestRequestTypeDef definition

class DeleteBackupRequestRequestTypeDef(TypedDict):
    BackupId: str,

DeleteClusterRequestRequestTypeDef#

# DeleteClusterRequestRequestTypeDef definition

class DeleteClusterRequestRequestTypeDef(TypedDict):
    ClusterId: str,

DeleteHsmRequestRequestTypeDef#

# DeleteHsmRequestRequestTypeDef definition

class DeleteHsmRequestRequestTypeDef(TypedDict):
    ClusterId: str,
    HsmId: NotRequired[str],
    EniId: NotRequired[str],
    EniIp: NotRequired[str],

DeleteResourcePolicyRequestRequestTypeDef#

# DeleteResourcePolicyRequestRequestTypeDef definition

class DeleteResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: NotRequired[str],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeBackupsRequestRequestTypeDef#

# DescribeBackupsRequestRequestTypeDef definition

class DescribeBackupsRequestRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Filters: NotRequired[Mapping[str, Sequence[str]]],
    Shared: NotRequired[bool],
    SortAscending: NotRequired[bool],

DescribeClustersRequestRequestTypeDef#

# DescribeClustersRequestRequestTypeDef definition

class DescribeClustersRequestRequestTypeDef(TypedDict):
    Filters: NotRequired[Mapping[str, Sequence[str]]],
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

GetResourcePolicyRequestRequestTypeDef#

# GetResourcePolicyRequestRequestTypeDef definition

class GetResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: NotRequired[str],

InitializeClusterRequestRequestTypeDef#

# InitializeClusterRequestRequestTypeDef definition

class InitializeClusterRequestRequestTypeDef(TypedDict):
    ClusterId: str,
    SignedCert: str,
    TrustAnchor: str,

ListTagsRequestRequestTypeDef#

# ListTagsRequestRequestTypeDef definition

class ListTagsRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ModifyBackupAttributesRequestRequestTypeDef#

# ModifyBackupAttributesRequestRequestTypeDef definition

class ModifyBackupAttributesRequestRequestTypeDef(TypedDict):
    BackupId: str,
    NeverExpires: bool,

PutResourcePolicyRequestRequestTypeDef#

# PutResourcePolicyRequestRequestTypeDef definition

class PutResourcePolicyRequestRequestTypeDef(TypedDict):
    ResourceArn: NotRequired[str],
    Policy: NotRequired[str],

RestoreBackupRequestRequestTypeDef#

# RestoreBackupRequestRequestTypeDef definition

class RestoreBackupRequestRequestTypeDef(TypedDict):
    BackupId: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    TagKeyList: Sequence[str],

ModifyClusterRequestRequestTypeDef#

# ModifyClusterRequestRequestTypeDef definition

class ModifyClusterRequestRequestTypeDef(TypedDict):
    BackupRetentionPolicy: BackupRetentionPolicyTypeDef,  # (1)
    ClusterId: str,
  1. See BackupRetentionPolicyTypeDef

BackupTypeDef#

# BackupTypeDef definition

class BackupTypeDef(TypedDict):
    BackupId: str,
    BackupArn: NotRequired[str],
    BackupState: NotRequired[BackupStateType],  # (1)
    ClusterId: NotRequired[str],
    CreateTimestamp: NotRequired[datetime],
    CopyTimestamp: NotRequired[datetime],
    NeverExpires: NotRequired[bool],
    SourceRegion: NotRequired[str],
    SourceBackup: NotRequired[str],
    SourceCluster: NotRequired[str],
    DeleteTimestamp: NotRequired[datetime],
    TagList: NotRequired[list[TagTypeDef]],  # (2)
    HsmType: NotRequired[str],
    Mode: NotRequired[ClusterModeType],  # (3)
  1. See BackupStateType
  2. See TagTypeDef
  3. See ClusterModeType

CopyBackupToRegionRequestRequestTypeDef#

# CopyBackupToRegionRequestRequestTypeDef definition

class CopyBackupToRegionRequestRequestTypeDef(TypedDict):
    DestinationRegion: str,
    BackupId: str,
    TagList: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateClusterRequestRequestTypeDef#

# CreateClusterRequestRequestTypeDef definition

class CreateClusterRequestRequestTypeDef(TypedDict):
    HsmType: str,
    SubnetIds: Sequence[str],
    BackupRetentionPolicy: NotRequired[BackupRetentionPolicyTypeDef],  # (1)
    SourceBackupId: NotRequired[str],
    NetworkType: NotRequired[NetworkTypeType],  # (2)
    TagList: NotRequired[Sequence[TagTypeDef]],  # (3)
    Mode: NotRequired[ClusterModeType],  # (4)
  1. See BackupRetentionPolicyTypeDef
  2. See NetworkTypeType
  3. See TagTypeDef
  4. See ClusterModeType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    ResourceId: str,
    TagList: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ClusterTypeDef#

# ClusterTypeDef definition

class ClusterTypeDef(TypedDict):
    BackupPolicy: NotRequired[BackupPolicyType],  # (1)
    BackupRetentionPolicy: NotRequired[BackupRetentionPolicyTypeDef],  # (2)
    ClusterId: NotRequired[str],
    CreateTimestamp: NotRequired[datetime],
    Hsms: NotRequired[list[HsmTypeDef]],  # (3)
    HsmType: NotRequired[str],
    PreCoPassword: NotRequired[str],
    SecurityGroup: NotRequired[str],
    SourceBackupId: NotRequired[str],
    State: NotRequired[ClusterStateType],  # (4)
    StateMessage: NotRequired[str],
    SubnetMapping: NotRequired[dict[str, str]],
    VpcId: NotRequired[str],
    NetworkType: NotRequired[NetworkTypeType],  # (5)
    Certificates: NotRequired[CertificatesTypeDef],  # (6)
    TagList: NotRequired[list[TagTypeDef]],  # (7)
    Mode: NotRequired[ClusterModeType],  # (8)
  1. See BackupPolicyType
  2. See BackupRetentionPolicyTypeDef
  3. See HsmTypeDef
  4. See ClusterStateType
  5. See NetworkTypeType
  6. See CertificatesTypeDef
  7. See TagTypeDef
  8. See ClusterModeType

CopyBackupToRegionResponseTypeDef#

# CopyBackupToRegionResponseTypeDef definition

class CopyBackupToRegionResponseTypeDef(TypedDict):
    DestinationBackup: DestinationBackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DestinationBackupTypeDef
  2. See ResponseMetadataTypeDef

CreateHsmResponseTypeDef#

# CreateHsmResponseTypeDef definition

class CreateHsmResponseTypeDef(TypedDict):
    Hsm: HsmTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See HsmTypeDef
  2. See ResponseMetadataTypeDef

DeleteHsmResponseTypeDef#

# DeleteHsmResponseTypeDef definition

class DeleteHsmResponseTypeDef(TypedDict):
    HsmId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteResourcePolicyResponseTypeDef#

# DeleteResourcePolicyResponseTypeDef definition

class DeleteResourcePolicyResponseTypeDef(TypedDict):
    ResourceArn: str,
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetResourcePolicyResponseTypeDef#

# GetResourcePolicyResponseTypeDef definition

class GetResourcePolicyResponseTypeDef(TypedDict):
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

InitializeClusterResponseTypeDef#

# InitializeClusterResponseTypeDef definition

class InitializeClusterResponseTypeDef(TypedDict):
    State: ClusterStateType,  # (1)
    StateMessage: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterStateType
  2. See ResponseMetadataTypeDef

ListTagsResponseTypeDef#

# ListTagsResponseTypeDef definition

class ListTagsResponseTypeDef(TypedDict):
    TagList: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

PutResourcePolicyResponseTypeDef#

# PutResourcePolicyResponseTypeDef definition

class PutResourcePolicyResponseTypeDef(TypedDict):
    ResourceArn: str,
    Policy: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeBackupsRequestPaginateTypeDef#

# DescribeBackupsRequestPaginateTypeDef definition

class DescribeBackupsRequestPaginateTypeDef(TypedDict):
    Filters: NotRequired[Mapping[str, Sequence[str]]],
    Shared: NotRequired[bool],
    SortAscending: NotRequired[bool],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeClustersRequestPaginateTypeDef#

# DescribeClustersRequestPaginateTypeDef definition

class DescribeClustersRequestPaginateTypeDef(TypedDict):
    Filters: NotRequired[Mapping[str, Sequence[str]]],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTagsRequestPaginateTypeDef#

# ListTagsRequestPaginateTypeDef definition

class ListTagsRequestPaginateTypeDef(TypedDict):
    ResourceId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DeleteBackupResponseTypeDef#

# DeleteBackupResponseTypeDef definition

class DeleteBackupResponseTypeDef(TypedDict):
    Backup: BackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupTypeDef
  2. See ResponseMetadataTypeDef

DescribeBackupsResponseTypeDef#

# DescribeBackupsResponseTypeDef definition

class DescribeBackupsResponseTypeDef(TypedDict):
    Backups: list[BackupTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See BackupTypeDef
  2. See ResponseMetadataTypeDef

ModifyBackupAttributesResponseTypeDef#

# ModifyBackupAttributesResponseTypeDef definition

class ModifyBackupAttributesResponseTypeDef(TypedDict):
    Backup: BackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupTypeDef
  2. See ResponseMetadataTypeDef

RestoreBackupResponseTypeDef#

# RestoreBackupResponseTypeDef definition

class RestoreBackupResponseTypeDef(TypedDict):
    Backup: BackupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BackupTypeDef
  2. See ResponseMetadataTypeDef

CreateClusterResponseTypeDef#

# CreateClusterResponseTypeDef definition

class CreateClusterResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

DeleteClusterResponseTypeDef#

# DeleteClusterResponseTypeDef definition

class DeleteClusterResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

DescribeClustersResponseTypeDef#

# DescribeClustersResponseTypeDef definition

class DescribeClustersResponseTypeDef(TypedDict):
    Clusters: list[ClusterTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef

ModifyClusterResponseTypeDef#

# ModifyClusterResponseTypeDef definition

class ModifyClusterResponseTypeDef(TypedDict):
    Cluster: ClusterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ClusterTypeDef
  2. See ResponseMetadataTypeDef