aws-cdk-lib 2.154.1__py3-none-any.whl → 2.156.0__py3-none-any.whl

aws_cdk/aws_docdb/__init__.py

@@ -283,6 +283,26 @@ cluster = docdb.DatabaseCluster(self, "Database",
     ca_certificate=docdb.CaCertificate.RDS_CA_RSA4096_G1
 )
 ```
+
+## Storage Type
+
+You can specify [storage type](https://docs.aws.amazon.com/documentdb/latest/developerguide/db-cluster-storage-configs.html) for the cluster.
+
+```python
+# vpc: ec2.Vpc
+
+
+cluster = docdb.DatabaseCluster(self, "Database",
+    master_user=docdb.Login(
+        username="myuser"
+    ),
+    instance_type=ec2.InstanceType.of(ec2.InstanceClass.MEMORY5, ec2.InstanceSize.LARGE),
+    vpc=vpc,
+    storage_type=docdb.StorageType.IOPT1
+)
+```
+
+**Note**: `StorageType.IOPT1` is supported starting with engine version 5.0.0.
 '''
 from pkgutil import extend_path
 __path__ = extend_path(__path__, __name__)
@@ -3460,6 +3480,7 @@ class DatabaseClusterAttributes:
         "security_group": "securityGroup",
         "security_group_removal_policy": "securityGroupRemovalPolicy",
         "storage_encrypted": "storageEncrypted",
+        "storage_type": "storageType",
         "vpc_subnets": "vpcSubnets",
     },
 )
@@ -3492,6 +3513,7 @@ class DatabaseClusterProps:
         security_group: typing.Optional[_ISecurityGroup_acf8a799] = None,
         security_group_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
         storage_encrypted: typing.Optional[builtins.bool] = None,
+        storage_type: typing.Optional["StorageType"] = None,
         vpc_subnets: typing.Optional[typing.Union[_SubnetSelection_e57d76df, typing.Dict[builtins.str, typing.Any]]] = None,
     ) -> None:
         '''Properties for a new database cluster.
@@ -3507,7 +3529,7 @@ class DatabaseClusterProps:
         :param db_cluster_name: An optional identifier for the cluster. Default: - A name is automatically generated.
         :param deletion_protection: Specifies whether this cluster can be deleted. If deletionProtection is enabled, the cluster cannot be deleted unless it is modified and deletionProtection is disabled. deletionProtection protects clusters from being accidentally deleted. Default: - false
         :param enable_performance_insights: A value that indicates whether to enable Performance Insights for the instances in the DB Cluster. Default: - false
-        :param engine_version: What version of the database to start. Default: - The default engine version.
+        :param engine_version: What version of the database to start. Default: - the latest major version
         :param export_audit_logs_to_cloud_watch: Whether the audit logs should be exported to CloudWatch. Note that you also have to configure the audit log export in the Cluster's Parameter Group. Default: false
         :param export_profiler_logs_to_cloud_watch: Whether the profiler logs should be exported to CloudWatch. Note that you also have to configure the profiler log export in the Cluster's Parameter Group. Default: false
         :param instance_identifier_base: Base identifier for instances. Every replica is named by appending the replica number to this string, 1-based. Default: - ``dbClusterName`` is used with the word "Instance" appended. If ``dbClusterName`` is not provided, the identifier is automatically generated.
@@ -3521,6 +3543,7 @@ class DatabaseClusterProps:
         :param security_group: Security group. Default: a new security group is created.
         :param security_group_removal_policy: The removal policy to apply to the cluster's security group. Cannot be set to ``SNAPSHOT``. Default: - ``RemovalPolicy.DESTROY`` when ``removalPolicy`` is set to ``SNAPSHOT``, ``removalPolicy`` otherwise.
         :param storage_encrypted: Whether to enable storage encryption. Default: true
+        :param storage_type: The storage type of the DocDB cluster. I/O-optimized storage is supported starting with engine version 5.0.0. Default: StorageType.STANDARD
         :param vpc_subnets: Where to place the instances within the VPC. Default: private subnets
 
         :exampleMetadata: infused
@@ -3539,7 +3562,7 @@ class DatabaseClusterProps:
                     subnet_type=ec2.SubnetType.PUBLIC
                 ),
                 vpc=vpc,
-                ca_certificate=docdb.CaCertificate.RDS_CA_RSA4096_G1
+                removal_policy=RemovalPolicy.SNAPSHOT
             )
         '''
         if isinstance(master_user, dict):
@@ -3575,6 +3598,7 @@ class DatabaseClusterProps:
             check_type(argname="argument security_group", value=security_group, expected_type=type_hints["security_group"])
             check_type(argname="argument security_group_removal_policy", value=security_group_removal_policy, expected_type=type_hints["security_group_removal_policy"])
             check_type(argname="argument storage_encrypted", value=storage_encrypted, expected_type=type_hints["storage_encrypted"])
+            check_type(argname="argument storage_type", value=storage_type, expected_type=type_hints["storage_type"])
             check_type(argname="argument vpc_subnets", value=vpc_subnets, expected_type=type_hints["vpc_subnets"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "instance_type": instance_type,
@@ -3625,6 +3649,8 @@ class DatabaseClusterProps:
             self._values["security_group_removal_policy"] = security_group_removal_policy
         if storage_encrypted is not None:
             self._values["storage_encrypted"] = storage_encrypted
+        if storage_type is not None:
+            self._values["storage_type"] = storage_type
         if vpc_subnets is not None:
             self._values["vpc_subnets"] = vpc_subnets
 
@@ -3747,7 +3773,7 @@ class DatabaseClusterProps:
     def engine_version(self) -> typing.Optional[builtins.str]:
         '''What version of the database to start.
 
-        :default: - The default engine version.
+        :default: - the latest major version
         '''
         result = self._values.get("engine_version")
         return typing.cast(typing.Optional[builtins.str], result)
@@ -3908,6 +3934,19 @@ class DatabaseClusterProps:
         result = self._values.get("storage_encrypted")
         return typing.cast(typing.Optional[builtins.bool], result)
 
+    @builtins.property
+    def storage_type(self) -> typing.Optional["StorageType"]:
+        '''The storage type of the DocDB cluster.
+
+        I/O-optimized storage is supported starting with engine version 5.0.0.
+
+        :default: StorageType.STANDARD
+
+        :see: https://docs.aws.amazon.com/documentdb/latest/developerguide/release-notes.html#release-notes.11-21-2023
+        '''
+        result = self._values.get("storage_type")
+        return typing.cast(typing.Optional["StorageType"], result)
+
     @builtins.property
     def vpc_subnets(self) -> typing.Optional[_SubnetSelection_e57d76df]:
         '''Where to place the instances within the VPC.
@@ -4721,7 +4760,7 @@ class Login:
                     subnet_type=ec2.SubnetType.PUBLIC
                 ),
                 vpc=vpc,
-                ca_certificate=docdb.CaCertificate.RDS_CA_RSA4096_G1
+                removal_policy=RemovalPolicy.SNAPSHOT
             )
         '''
         if __debug__:
@@ -4884,6 +4923,33 @@ class RotationMultiUserOptions:
         )
 
 
+@jsii.enum(jsii_type="aws-cdk-lib.aws_docdb.StorageType")
+class StorageType(enum.Enum):
+    '''The storage type of the DocDB cluster.
+
+    :exampleMetadata: infused
+
+    Example::
+
+        # vpc: ec2.Vpc
+        
+        
+        cluster = docdb.DatabaseCluster(self, "Database",
+            master_user=docdb.Login(
+                username="myuser"
+            ),
+            instance_type=ec2.InstanceType.of(ec2.InstanceClass.MEMORY5, ec2.InstanceSize.LARGE),
+            vpc=vpc,
+            storage_type=docdb.StorageType.IOPT1
+        )
+    '''
+
+    STANDARD = "STANDARD"
+    '''Standard storage.'''
+    IOPT1 = "IOPT1"
+    '''I/O-optimized storage.'''
+
+
 @jsii.implements(IClusterParameterGroup)
 class ClusterParameterGroup(
     _Resource_45bc6135,
@@ -4997,7 +5063,7 @@ class DatabaseCluster(
                 subnet_type=ec2.SubnetType.PUBLIC
             ),
             vpc=vpc,
-            ca_certificate=docdb.CaCertificate.RDS_CA_RSA4096_G1
+            removal_policy=RemovalPolicy.SNAPSHOT
         )
     '''
 
@@ -5031,6 +5097,7 @@ class DatabaseCluster(
         security_group: typing.Optional[_ISecurityGroup_acf8a799] = None,
         security_group_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
         storage_encrypted: typing.Optional[builtins.bool] = None,
+        storage_type: typing.Optional[StorageType] = None,
         vpc_subnets: typing.Optional[typing.Union[_SubnetSelection_e57d76df, typing.Dict[builtins.str, typing.Any]]] = None,
     ) -> None:
         '''
@@ -5047,7 +5114,7 @@ class DatabaseCluster(
         :param db_cluster_name: An optional identifier for the cluster. Default: - A name is automatically generated.
         :param deletion_protection: Specifies whether this cluster can be deleted. If deletionProtection is enabled, the cluster cannot be deleted unless it is modified and deletionProtection is disabled. deletionProtection protects clusters from being accidentally deleted. Default: - false
         :param enable_performance_insights: A value that indicates whether to enable Performance Insights for the instances in the DB Cluster. Default: - false
-        :param engine_version: What version of the database to start. Default: - The default engine version.
+        :param engine_version: What version of the database to start. Default: - the latest major version
         :param export_audit_logs_to_cloud_watch: Whether the audit logs should be exported to CloudWatch. Note that you also have to configure the audit log export in the Cluster's Parameter Group. Default: false
         :param export_profiler_logs_to_cloud_watch: Whether the profiler logs should be exported to CloudWatch. Note that you also have to configure the profiler log export in the Cluster's Parameter Group. Default: false
         :param instance_identifier_base: Base identifier for instances. Every replica is named by appending the replica number to this string, 1-based. Default: - ``dbClusterName`` is used with the word "Instance" appended. If ``dbClusterName`` is not provided, the identifier is automatically generated.
@@ -5061,6 +5128,7 @@ class DatabaseCluster(
         :param security_group: Security group. Default: a new security group is created.
         :param security_group_removal_policy: The removal policy to apply to the cluster's security group. Cannot be set to ``SNAPSHOT``. Default: - ``RemovalPolicy.DESTROY`` when ``removalPolicy`` is set to ``SNAPSHOT``, ``removalPolicy`` otherwise.
         :param storage_encrypted: Whether to enable storage encryption. Default: true
+        :param storage_type: The storage type of the DocDB cluster. I/O-optimized storage is supported starting with engine version 5.0.0. Default: StorageType.STANDARD
         :param vpc_subnets: Where to place the instances within the VPC. Default: private subnets
         '''
         if __debug__:
@@ -5093,6 +5161,7 @@ class DatabaseCluster(
             security_group=security_group,
             security_group_removal_policy=security_group_removal_policy,
             storage_encrypted=storage_encrypted,
+            storage_type=storage_type,
             vpc_subnets=vpc_subnets,
         )
 
@@ -5461,6 +5530,7 @@ __all__ = [
     "IDatabaseInstance",
     "Login",
     "RotationMultiUserOptions",
+    "StorageType",
 ]
 
 publication.publish()
@@ -6051,6 +6121,7 @@ def _typecheckingstub__bb24ec128a97ca07df15f55d4e96dda851d4300951806a7a3d7f391cc
     security_group: typing.Optional[_ISecurityGroup_acf8a799] = None,
     security_group_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
     storage_encrypted: typing.Optional[builtins.bool] = None,
+    storage_type: typing.Optional[StorageType] = None,
     vpc_subnets: typing.Optional[typing.Union[_SubnetSelection_e57d76df, typing.Dict[builtins.str, typing.Any]]] = None,
 ) -> None:
     """Type checking stubs"""
@@ -6179,6 +6250,7 @@ def _typecheckingstub__3fef762ebf4d69195051e79f76d91c6d9e93e2a84a6c1e71f7b4a0b8c
     security_group: typing.Optional[_ISecurityGroup_acf8a799] = None,
     security_group_removal_policy: typing.Optional[_RemovalPolicy_9f93c814] = None,
     storage_encrypted: typing.Optional[builtins.bool] = None,
+    storage_type: typing.Optional[StorageType] = None,
     vpc_subnets: typing.Optional[typing.Union[_SubnetSelection_e57d76df, typing.Dict[builtins.str, typing.Any]]] = None,
 ) -> None:
     """Type checking stubs"""