Skip to content

Docdb Elastic Classes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

ClusterInListTypeDef

clusterArn

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'COPYING', 'CREATING', 'DELETING', 'INACCESSIBLE_ENCRYPTION_CREDS', 'INACCESSIBLE_SECRET_ARN', 'INACCESSIBLE_VPC_ENDPOINT', 'INCOMPATIBLE_NETWORK', 'INVALID_SECURITY_GROUP_ID', 'INVALID_SUBNET_ID', 'IP_ADDRESS_LIMIT_EXCEEDED', 'MERGING', 'MODIFYING', 'SPLITTING', 'STARTING', 'STOPPED', 'STOPPING', 'UPDATING', 'VPC_ENDPOINT_LIMIT_EXCEEDED']
  • Required: Yes

ClusterSnapshotInListTypeDef

clusterArn

  • Type:
  • Required: Yes

snapshotArn

  • Type:
  • Required: Yes

snapshotCreationTime

  • Type:
  • Required: Yes

snapshotName

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'COPYING', 'CREATING', 'DELETING', 'INACCESSIBLE_ENCRYPTION_CREDS', 'INACCESSIBLE_SECRET_ARN', 'INACCESSIBLE_VPC_ENDPOINT', 'INCOMPATIBLE_NETWORK', 'INVALID_SECURITY_GROUP_ID', 'INVALID_SUBNET_ID', 'IP_ADDRESS_LIMIT_EXCEEDED', 'MERGING', 'MODIFYING', 'SPLITTING', 'STARTING', 'STOPPED', 'STOPPING', 'UPDATING', 'VPC_ENDPOINT_LIMIT_EXCEEDED']
  • Required: Yes

ClusterSnapshotTypeDef

adminUserName

  • Type:
  • Required: Yes

clusterArn

  • Type:
  • Required: Yes

clusterCreationTime

  • Type:
  • Required: Yes

kmsKeyId

  • Type:
  • Required: Yes

snapshotArn

  • Type:
  • Required: Yes

snapshotCreationTime

  • Type:
  • Required: Yes

snapshotName

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'COPYING', 'CREATING', 'DELETING', 'INACCESSIBLE_ENCRYPTION_CREDS', 'INACCESSIBLE_SECRET_ARN', 'INACCESSIBLE_VPC_ENDPOINT', 'INCOMPATIBLE_NETWORK', 'INVALID_SECURITY_GROUP_ID', 'INVALID_SUBNET_ID', 'IP_ADDRESS_LIMIT_EXCEEDED', 'MERGING', 'MODIFYING', 'SPLITTING', 'STARTING', 'STOPPED', 'STOPPING', 'UPDATING', 'VPC_ENDPOINT_LIMIT_EXCEEDED']
  • Required: Yes

subnetIds

  • Type: typing.List[str]
  • Required: Yes

vpcSecurityGroupIds

  • Type: typing.List[str]
  • Required: Yes

snapshotType

  • Type: typing.Optional[typing.Literal['AUTOMATED', 'MANUAL']]

ClusterTypeDef

adminUserName

  • Type:
  • Required: Yes

authType

  • Type: typing.Literal['PLAIN_TEXT', 'SECRET_ARN']
  • Required: Yes

clusterArn

  • Type:
  • Required: Yes

clusterEndpoint

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

kmsKeyId

  • Type:
  • Required: Yes

preferredMaintenanceWindow

  • Type:
  • Required: Yes

shardCapacity

  • Type:
  • Required: Yes

shardCount

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'COPYING', 'CREATING', 'DELETING', 'INACCESSIBLE_ENCRYPTION_CREDS', 'INACCESSIBLE_SECRET_ARN', 'INACCESSIBLE_VPC_ENDPOINT', 'INCOMPATIBLE_NETWORK', 'INVALID_SECURITY_GROUP_ID', 'INVALID_SUBNET_ID', 'IP_ADDRESS_LIMIT_EXCEEDED', 'MERGING', 'MODIFYING', 'SPLITTING', 'STARTING', 'STOPPED', 'STOPPING', 'UPDATING', 'VPC_ENDPOINT_LIMIT_EXCEEDED']
  • Required: Yes

subnetIds

  • Type: typing.List[str]
  • Required: Yes

vpcSecurityGroupIds

  • Type: typing.List[str]
  • Required: Yes

backupRetentionPeriod

  • Type: typing.Optional[int]

preferredBackupWindow

  • Type: typing.Optional[str]

shardInstanceCount

  • Type: typing.Optional[int]

shards

  • Type: typing.Optional[typing.List[aws_resource_validator.pydantic_models.docdb_elastic_classes.ShardTypeDef]]

CopyClusterSnapshotInputRequestTypeDef

snapshotArn

  • Type:
  • Required: Yes

targetSnapshotName

  • Type:
  • Required: Yes

copyTags

  • Type: typing.Optional[bool]

kmsKeyId

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CopyClusterSnapshotOutputTypeDef

snapshot

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateClusterInputRequestTypeDef

adminUserName

  • Type:
  • Required: Yes

adminUserPassword

  • Type:
  • Required: Yes

authType

  • Type: typing.Literal['PLAIN_TEXT', 'SECRET_ARN']
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

shardCapacity

  • Type:
  • Required: Yes

shardCount

  • Type:
  • Required: Yes

backupRetentionPeriod

  • Type: typing.Optional[int]

clientToken

  • Type: typing.Optional[str]

kmsKeyId

  • Type: typing.Optional[str]

preferredBackupWindow

  • Type: typing.Optional[str]

preferredMaintenanceWindow

  • Type: typing.Optional[str]

shardInstanceCount

  • Type: typing.Optional[int]

subnetIds

  • Type: typing.Optional[typing.Sequence[str]]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

vpcSecurityGroupIds

  • Type: typing.Optional[typing.Sequence[str]]

CreateClusterOutputTypeDef

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateClusterSnapshotInputRequestTypeDef

clusterArn

  • Type:
  • Required: Yes

snapshotName

  • Type:
  • Required: Yes

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateClusterSnapshotOutputTypeDef

snapshot

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteClusterInputRequestTypeDef

clusterArn

  • Type:
  • Required: Yes

DeleteClusterOutputTypeDef

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteClusterSnapshotInputRequestTypeDef

snapshotArn

  • Type:
  • Required: Yes

DeleteClusterSnapshotOutputTypeDef

snapshot

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetClusterInputRequestTypeDef

clusterArn

  • Type:
  • Required: Yes

GetClusterOutputTypeDef

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetClusterSnapshotInputRequestTypeDef

snapshotArn

  • Type:
  • Required: Yes

GetClusterSnapshotOutputTypeDef

snapshot

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListClusterSnapshotsInputListClusterSnapshotsPaginateTypeDef

clusterArn

  • Type: typing.Optional[str]

snapshotType

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.docdb_elastic_classes.PaginatorConfigTypeDef]

ListClusterSnapshotsInputRequestTypeDef

clusterArn

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

snapshotType

  • Type: typing.Optional[str]

ListClusterSnapshotsOutputTypeDef

nextToken

  • Type:
  • Required: Yes

snapshots

  • Type: typing.List[aws_resource_validator.pydantic_models.docdb_elastic_classes.ClusterSnapshotInListTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListClustersInputListClustersPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.docdb_elastic_classes.PaginatorConfigTypeDef]

ListClustersInputRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListClustersOutputTypeDef

clusters

  • Type: typing.List[aws_resource_validator.pydantic_models.docdb_elastic_classes.ClusterInListTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

RestoreClusterFromSnapshotInputRequestTypeDef

clusterName

  • Type:
  • Required: Yes

snapshotArn

  • Type:
  • Required: Yes

kmsKeyId

  • Type: typing.Optional[str]

shardCapacity

  • Type: typing.Optional[int]

shardInstanceCount

  • Type: typing.Optional[int]

subnetIds

  • Type: typing.Optional[typing.Sequence[str]]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

vpcSecurityGroupIds

  • Type: typing.Optional[typing.Sequence[str]]

RestoreClusterFromSnapshotOutputTypeDef

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ShardTypeDef

createTime

  • Type:
  • Required: Yes

shardId

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'COPYING', 'CREATING', 'DELETING', 'INACCESSIBLE_ENCRYPTION_CREDS', 'INACCESSIBLE_SECRET_ARN', 'INACCESSIBLE_VPC_ENDPOINT', 'INCOMPATIBLE_NETWORK', 'INVALID_SECURITY_GROUP_ID', 'INVALID_SUBNET_ID', 'IP_ADDRESS_LIMIT_EXCEEDED', 'MERGING', 'MODIFYING', 'SPLITTING', 'STARTING', 'STOPPED', 'STOPPING', 'UPDATING', 'VPC_ENDPOINT_LIMIT_EXCEEDED']
  • Required: Yes

StartClusterInputRequestTypeDef

clusterArn

  • Type:
  • Required: Yes

StartClusterOutputTypeDef

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopClusterInputRequestTypeDef

clusterArn

  • Type:
  • Required: Yes

StopClusterOutputTypeDef

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Mapping[str, str]
  • Required: Yes

UntagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdateClusterInputRequestTypeDef

clusterArn

  • Type:
  • Required: Yes

adminUserPassword

  • Type: typing.Optional[str]

authType

  • Type: typing.Optional[typing.Literal['PLAIN_TEXT', 'SECRET_ARN']]

backupRetentionPeriod

  • Type: typing.Optional[int]

clientToken

  • Type: typing.Optional[str]

preferredBackupWindow

  • Type: typing.Optional[str]

preferredMaintenanceWindow

  • Type: typing.Optional[str]

shardCapacity

  • Type: typing.Optional[int]

shardCount

  • Type: typing.Optional[int]

shardInstanceCount

  • Type: typing.Optional[int]

subnetIds

  • Type: typing.Optional[typing.Sequence[str]]

vpcSecurityGroupIds

  • Type: typing.Optional[typing.Sequence[str]]

UpdateClusterOutputTypeDef

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes