Skip to content

Docdb Elastic Classes

ApplyPendingMaintenanceActionInput

applyAction

  • Type:
  • Required: Yes

optInType

  • Type: typing.Literal['APPLY_ON', 'IMMEDIATE', 'NEXT_MAINTENANCE', 'UNDO_OPT_IN']
  • Required: Yes

resourceArn

  • Type:
  • Required: Yes

applyOn

  • Type: typing.Optional[str]

ApplyPendingMaintenanceActionOutput

resourcePendingMaintenanceAction

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

BaseValidatorModel

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

Cluster

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_CREDENTIALS_RECOVERABLE', 'INACCESSIBLE_ENCRYPTION_CREDS', 'INACCESSIBLE_SECRET_ARN', 'INACCESSIBLE_VPC_ENDPOINT', 'INCOMPATIBLE_NETWORK', 'INVALID_SECURITY_GROUP_ID', 'INVALID_SUBNET_ID', 'IP_ADDRESS_LIMIT_EXCEEDED', 'MAINTENANCE', '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.docdb_elastic_classes.Shard]]

ClusterInList

clusterArn

  • Type:
  • Required: Yes

clusterName

  • Type:
  • Required: Yes

status

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

ClusterSnapshot

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_CREDENTIALS_RECOVERABLE', 'INACCESSIBLE_ENCRYPTION_CREDS', 'INACCESSIBLE_SECRET_ARN', 'INACCESSIBLE_VPC_ENDPOINT', 'INCOMPATIBLE_NETWORK', 'INVALID_SECURITY_GROUP_ID', 'INVALID_SUBNET_ID', 'IP_ADDRESS_LIMIT_EXCEEDED', 'MAINTENANCE', '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']]

ClusterSnapshotInList

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_CREDENTIALS_RECOVERABLE', 'INACCESSIBLE_ENCRYPTION_CREDS', 'INACCESSIBLE_SECRET_ARN', 'INACCESSIBLE_VPC_ENDPOINT', 'INCOMPATIBLE_NETWORK', 'INVALID_SECURITY_GROUP_ID', 'INVALID_SUBNET_ID', 'IP_ADDRESS_LIMIT_EXCEEDED', 'MAINTENANCE', 'MERGING', 'MODIFYING', 'SPLITTING', 'STARTING', 'STOPPED', 'STOPPING', 'UPDATING', 'VPC_ENDPOINT_LIMIT_EXCEEDED']
  • Required: Yes

CopyClusterSnapshotInput

snapshotArn

  • Type:
  • Required: Yes

targetSnapshotName

  • Type:
  • Required: Yes

copyTags

  • Type: typing.Optional[bool]

kmsKeyId

  • Type: typing.Optional[str]

tags

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

CopyClusterSnapshotOutput

snapshot

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateClusterInput

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.List[str]]

tags

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

vpcSecurityGroupIds

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

CreateClusterOutput

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateClusterSnapshotInput

clusterArn

  • Type:
  • Required: Yes

snapshotName

  • Type:
  • Required: Yes

tags

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

CreateClusterSnapshotOutput

snapshot

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteClusterInput

clusterArn

  • Type:
  • Required: Yes

DeleteClusterOutput

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DeleteClusterSnapshotInput

snapshotArn

  • Type:
  • Required: Yes

DeleteClusterSnapshotOutput

snapshot

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetClusterInput

clusterArn

  • Type:
  • Required: Yes

GetClusterOutput

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetClusterSnapshotInput

snapshotArn

  • Type:
  • Required: Yes

GetClusterSnapshotOutput

snapshot

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetPendingMaintenanceActionInput

resourceArn

  • Type:
  • Required: Yes

GetPendingMaintenanceActionOutput

resourcePendingMaintenanceAction

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListClusterSnapshotsInput

clusterArn

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

snapshotType

  • Type: typing.Optional[str]

ListClusterSnapshotsInputPaginate

clusterArn

  • Type: typing.Optional[str]

snapshotType

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.docdb_elastic.docdb_elastic_classes.PaginatorConfig]

ListClusterSnapshotsOutput

snapshots

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

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListClustersInput

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListClustersInputPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.docdb_elastic.docdb_elastic_classes.PaginatorConfig]

ListClustersOutput

clusters

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

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListPendingMaintenanceActionsInput

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListPendingMaintenanceActionsInputPaginate

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.docdb_elastic.docdb_elastic_classes.PaginatorConfig]

ListPendingMaintenanceActionsOutput

resourcePendingMaintenanceActions

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

ResponseMetadata

  • Type:
  • Required: Yes

nextToken

  • Type: typing.Optional[str]

ListTagsForResourceRequest

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponse

tags

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

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfig

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PendingMaintenanceActionDetails

action

  • Type:
  • Required: Yes

autoAppliedAfterDate

  • Type: typing.Optional[str]

currentApplyDate

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

forcedApplyDate

  • Type: typing.Optional[str]

optInStatus

  • Type: typing.Optional[str]

ResourcePendingMaintenanceAction

pendingMaintenanceActionDetails

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

resourceArn

  • Type: typing.Optional[str]

ResponseMetadata

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]

RestoreClusterFromSnapshotInput

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.List[str]]

tags

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

vpcSecurityGroupIds

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

RestoreClusterFromSnapshotOutput

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

Shard

createTime

  • Type:
  • Required: Yes

shardId

  • Type:
  • Required: Yes

status

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

StartClusterInput

clusterArn

  • Type:
  • Required: Yes

StartClusterOutput

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StopClusterInput

clusterArn

  • Type:
  • Required: Yes

StopClusterOutput

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

TagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tags

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

UntagResourceRequest

resourceArn

  • Type:
  • Required: Yes

tagKeys

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

UpdateClusterInput

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.List[str]]

vpcSecurityGroupIds

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

UpdateClusterOutput

cluster

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes