aws-cdk-lib 2.165.0__py3-none-any.whl → 2.167.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +1 -1
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.165.0.jsii.tgz → aws-cdk-lib@2.167.0.jsii.tgz} +0 -0
- aws_cdk/aws_apigateway/__init__.py +9 -0
- aws_cdk/aws_appsync/__init__.py +2271 -359
- aws_cdk/aws_backup/__init__.py +57 -31
- aws_cdk/aws_bedrock/__init__.py +994 -197
- aws_cdk/aws_cleanrooms/__init__.py +66 -5
- aws_cdk/aws_cloudfront/__init__.py +21 -3
- aws_cdk/aws_cloudfront/experimental/__init__.py +3 -3
- aws_cdk/aws_codebuild/__init__.py +59 -29
- aws_cdk/aws_codepipeline/__init__.py +98 -5
- aws_cdk/aws_codestar/__init__.py +1 -1
- aws_cdk/aws_cognito/__init__.py +0 -8
- aws_cdk/aws_connect/__init__.py +1 -1
- aws_cdk/aws_datasync/__init__.py +60 -7
- aws_cdk/aws_devopsguru/__init__.py +2 -2
- aws_cdk/aws_dms/__init__.py +762 -0
- aws_cdk/aws_dynamodb/__init__.py +13 -8
- aws_cdk/aws_ec2/__init__.py +316 -11
- aws_cdk/aws_ecs/__init__.py +20 -7
- aws_cdk/aws_elasticache/__init__.py +16 -9
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +73 -46
- aws_cdk/aws_emrserverless/__init__.py +35 -33
- aws_cdk/aws_events/__init__.py +25 -30
- aws_cdk/aws_gamelift/__init__.py +52 -40
- aws_cdk/aws_inspectorv2/__init__.py +6 -12
- aws_cdk/aws_kinesis/__init__.py +297 -1
- aws_cdk/aws_kms/__init__.py +2 -0
- aws_cdk/aws_lambda/__init__.py +339 -22
- aws_cdk/aws_lambda_nodejs/__init__.py +3 -3
- aws_cdk/aws_logs/__init__.py +214 -0
- aws_cdk/aws_m2/__init__.py +58 -58
- aws_cdk/aws_mediapackagev2/__init__.py +191 -0
- aws_cdk/aws_networkfirewall/__init__.py +14 -5
- aws_cdk/aws_nimblestudio/__init__.py +6 -103
- aws_cdk/aws_opensearchservice/__init__.py +969 -0
- aws_cdk/aws_pipes/__init__.py +1 -1
- aws_cdk/aws_qbusiness/__init__.py +2 -0
- aws_cdk/aws_quicksight/__init__.py +481 -10
- aws_cdk/aws_rds/__init__.py +667 -16
- aws_cdk/aws_route53/__init__.py +38 -12
- aws_cdk/aws_s3_assets/__init__.py +37 -0
- aws_cdk/aws_s3_deployment/__init__.py +18 -7
- aws_cdk/aws_sagemaker/__init__.py +61 -25
- aws_cdk/aws_secretsmanager/__init__.py +2 -1
- aws_cdk/aws_servicecatalog/__init__.py +52 -4
- aws_cdk/aws_ses/__init__.py +22 -1
- aws_cdk/aws_sqs/__init__.py +12 -9
- aws_cdk/aws_stepfunctions/__init__.py +8 -0
- aws_cdk/aws_synthetics/__init__.py +133 -1
- aws_cdk/aws_timestream/__init__.py +41 -0
- aws_cdk/aws_wisdom/__init__.py +2348 -54
- aws_cdk/triggers/__init__.py +3 -3
- {aws_cdk_lib-2.165.0.dist-info → aws_cdk_lib-2.167.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.165.0.dist-info → aws_cdk_lib-2.167.0.dist-info}/RECORD +60 -60
- {aws_cdk_lib-2.165.0.dist-info → aws_cdk_lib-2.167.0.dist-info}/WHEEL +1 -1
- {aws_cdk_lib-2.165.0.dist-info → aws_cdk_lib-2.167.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.165.0.dist-info → aws_cdk_lib-2.167.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.165.0.dist-info → aws_cdk_lib-2.167.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_ecs/__init__.py
CHANGED
|
@@ -10765,13 +10765,13 @@ class CfnService(
|
|
|
10765
10765
|
) -> None:
|
|
10766
10766
|
'''The configuration for the Amazon EBS volume that Amazon ECS creates and manages on your behalf.
|
|
10767
10767
|
|
|
10768
|
-
These settings are used to create each Amazon EBS volume, with one volume created for each task in the service.
|
|
10768
|
+
These settings are used to create each Amazon EBS volume, with one volume created for each task in the service. For information about the supported launch types and operating systems, see `Supported operating systems and launch types <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-volumes.html#ebs-volumes-configuration>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
10769
10769
|
|
|
10770
10770
|
Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters.
|
|
10771
10771
|
|
|
10772
10772
|
:param role_arn: The ARN of the IAM role to associate with this volume. This is the Amazon ECS infrastructure IAM role that is used to manage your AWS infrastructure. We recommend using the Amazon ECS-managed ``AmazonECSInfrastructureRolePolicyForVolumes`` IAM policy with this role. For more information, see `Amazon ECS infrastructure IAM role <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/infrastructure_IAM_role.html>`_ in the *Amazon ECS Developer Guide* .
|
|
10773
10773
|
:param encrypted: Indicates whether the volume should be encrypted. If no value is specified, encryption is turned on by default. This parameter maps 1:1 with the ``Encrypted`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`_ in the *Amazon EC2 API Reference* .
|
|
10774
|
-
:param filesystem_type: The
|
|
10774
|
+
:param filesystem_type: The filesystem type for the volume. For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start. The available Linux filesystem types are ``ext3`` , ``ext4`` , and ``xfs`` . If no value is specified, the ``xfs`` filesystem type is used by default. The available Windows filesystem types are ``NTFS`` .
|
|
10775
10775
|
:param iops: The number of I/O operations per second (IOPS). For ``gp3`` , ``io1`` , and ``io2`` volumes, this represents the number of IOPS that are provisioned for the volume. For ``gp2`` volumes, this represents the baseline performance of the volume and the rate at which the volume accumulates I/O credits for bursting. The following are the supported values for each volume type. - ``gp3`` : 3,000 - 16,000 IOPS - ``io1`` : 100 - 64,000 IOPS - ``io2`` : 100 - 256,000 IOPS This parameter is required for ``io1`` and ``io2`` volume types. The default for ``gp3`` volumes is ``3,000 IOPS`` . This parameter is not supported for ``st1`` , ``sc1`` , or ``standard`` volume types. This parameter maps 1:1 with the ``Iops`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`_ in the *Amazon EC2 API Reference* .
|
|
10776
10776
|
:param kms_key_id: The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When encryption is turned on and no AWS Key Management Service key is specified, the default AWS managed key for Amazon EBS volumes is used. This parameter maps 1:1 with the ``KmsKeyId`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`_ in the *Amazon EC2 API Reference* . .. epigraph:: AWS authenticates the AWS Key Management Service key asynchronously. Therefore, if you specify an ID, alias, or ARN that is invalid, the action can appear to complete, but eventually fails.
|
|
10777
10777
|
:param size_in_gib: The size of the volume in GiB. You must specify either a volume size or a snapshot ID. If you specify a snapshot ID, the snapshot size is used for the volume size by default. You can optionally specify a volume size greater than or equal to the snapshot size. This parameter maps 1:1 with the ``Size`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`_ in the *Amazon EC2 API Reference* . The following are the supported volume size values for each volume type. - ``gp2`` and ``gp3`` : 1-16,384 - ``io1`` and ``io2`` : 4-16,384 - ``st1`` and ``sc1`` : 125-16,384 - ``standard`` : 1-1,024
|
|
@@ -10874,11 +10874,13 @@ class CfnService(
|
|
|
10874
10874
|
|
|
10875
10875
|
@builtins.property
|
|
10876
10876
|
def filesystem_type(self) -> typing.Optional[builtins.str]:
|
|
10877
|
-
'''The
|
|
10877
|
+
'''The filesystem type for the volume.
|
|
10878
10878
|
|
|
10879
10879
|
For volumes created from a snapshot, you must specify the same filesystem type that the volume was using when the snapshot was created. If there is a filesystem type mismatch, the task will fail to start.
|
|
10880
10880
|
|
|
10881
|
-
The available filesystem types are ``ext3`` , ``ext4`` , and ``xfs`` . If no value is specified, the ``xfs`` filesystem type is used by default.
|
|
10881
|
+
The available Linux filesystem types are ``ext3`` , ``ext4`` , and ``xfs`` . If no value is specified, the ``xfs`` filesystem type is used by default.
|
|
10882
|
+
|
|
10883
|
+
The available Windows filesystem types are ``NTFS`` .
|
|
10882
10884
|
|
|
10883
10885
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-filesystemtype
|
|
10884
10886
|
'''
|
|
@@ -14656,7 +14658,7 @@ class CfnTaskDefinition(
|
|
|
14656
14658
|
- Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see `AWS Fargate Platform Versions <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html>`_ .
|
|
14657
14659
|
- Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
|
|
14658
14660
|
|
|
14659
|
-
:param command: A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. When you use the AWS Management Console JSON panel, the AWS Command Line Interface , or the APIs, enclose the list of commands in double quotes and brackets. ``[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`` You don't include the double quotes and brackets when you use the AWS Management Console. ``CMD-SHELL, curl -f http://localhost/ || exit 1`` An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the docker container create command
|
|
14661
|
+
:param command: A string array representing the command that the container runs to determine if it is healthy. The string array must start with ``CMD`` to run the command arguments directly, or ``CMD-SHELL`` to run the command with the container's default shell. When you use the AWS Management Console JSON panel, the AWS Command Line Interface , or the APIs, enclose the list of commands in double quotes and brackets. ``[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]`` You don't include the double quotes and brackets when you use the AWS Management Console. ``CMD-SHELL, curl -f http://localhost/ || exit 1`` An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the docker container create command.
|
|
14660
14662
|
:param interval: The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
|
|
14661
14663
|
:param retries: The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
|
|
14662
14664
|
:param start_period: The optional grace period to provide containers time to bootstrap before failed health checks count towards the maximum number of retries. You can specify between 0 and 300 seconds. By default, the ``startPeriod`` is off. .. epigraph:: If a health check succeeds within the ``startPeriod`` , then the container is considered healthy and any subsequent failures count toward the maximum number of retries.
|
|
@@ -14712,7 +14714,7 @@ class CfnTaskDefinition(
|
|
|
14712
14714
|
|
|
14713
14715
|
``CMD-SHELL, curl -f http://localhost/ || exit 1``
|
|
14714
14716
|
|
|
14715
|
-
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the docker container create command
|
|
14717
|
+
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see ``HealthCheck`` in the docker container create command.
|
|
14716
14718
|
|
|
14717
14719
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-healthcheck.html#cfn-ecs-taskdefinition-healthcheck-command
|
|
14718
14720
|
'''
|
|
@@ -24899,6 +24901,7 @@ class EnvironmentFile(
|
|
|
24899
24901
|
*,
|
|
24900
24902
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
24901
24903
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
24904
|
+
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
24902
24905
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
24903
24906
|
asset_hash_type: typing.Optional[_AssetHashType_05b67f2d] = None,
|
|
24904
24907
|
bundling: typing.Optional[typing.Union[_BundlingOptions_588cc936, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -24911,6 +24914,7 @@ class EnvironmentFile(
|
|
|
24911
24914
|
:param path: Local disk path.
|
|
24912
24915
|
:param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
|
|
24913
24916
|
:param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
|
|
24917
|
+
:param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
|
|
24914
24918
|
:param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
|
|
24915
24919
|
:param asset_hash_type: Specifies the type of hash to calculate for this asset. If ``assetHash`` is configured, this option must be ``undefined`` or ``AssetHashType.CUSTOM``. Default: - the default is ``AssetHashType.SOURCE``, but if ``assetHash`` is explicitly specified this value defaults to ``AssetHashType.CUSTOM``.
|
|
24916
24920
|
:param bundling: Bundle the asset by executing a command in a Docker container or a custom bundling provider. The asset path will be mounted at ``/asset-input``. The Docker container is responsible for putting content at ``/asset-output``. The content at ``/asset-output`` will be zipped and used as the final asset. Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwise
|
|
@@ -24924,6 +24928,7 @@ class EnvironmentFile(
|
|
|
24924
24928
|
options = _AssetOptions_2aa69621(
|
|
24925
24929
|
deploy_time=deploy_time,
|
|
24926
24930
|
readers=readers,
|
|
24931
|
+
source_kms_key=source_kms_key,
|
|
24927
24932
|
asset_hash=asset_hash,
|
|
24928
24933
|
asset_hash_type=asset_hash_type,
|
|
24929
24934
|
bundling=bundling,
|
|
@@ -38107,9 +38112,11 @@ class AssetEnvironmentFile(
|
|
|
38107
38112
|
import aws_cdk as cdk
|
|
38108
38113
|
from aws_cdk import aws_ecs as ecs
|
|
38109
38114
|
from aws_cdk import aws_iam as iam
|
|
38115
|
+
from aws_cdk import aws_kms as kms
|
|
38110
38116
|
|
|
38111
38117
|
# docker_image: cdk.DockerImage
|
|
38112
38118
|
# grantable: iam.IGrantable
|
|
38119
|
+
# key: kms.Key
|
|
38113
38120
|
# local_bundling: cdk.ILocalBundling
|
|
38114
38121
|
|
|
38115
38122
|
asset_environment_file = ecs.AssetEnvironmentFile("path",
|
|
@@ -38145,7 +38152,8 @@ class AssetEnvironmentFile(
|
|
|
38145
38152
|
exclude=["exclude"],
|
|
38146
38153
|
follow_symlinks=cdk.SymlinkFollowMode.NEVER,
|
|
38147
38154
|
ignore_mode=cdk.IgnoreMode.GLOB,
|
|
38148
|
-
readers=[grantable]
|
|
38155
|
+
readers=[grantable],
|
|
38156
|
+
source_kMSKey=key
|
|
38149
38157
|
)
|
|
38150
38158
|
'''
|
|
38151
38159
|
|
|
@@ -38155,6 +38163,7 @@ class AssetEnvironmentFile(
|
|
|
38155
38163
|
*,
|
|
38156
38164
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
38157
38165
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
38166
|
+
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
38158
38167
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
38159
38168
|
asset_hash_type: typing.Optional[_AssetHashType_05b67f2d] = None,
|
|
38160
38169
|
bundling: typing.Optional[typing.Union[_BundlingOptions_588cc936, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -38166,6 +38175,7 @@ class AssetEnvironmentFile(
|
|
|
38166
38175
|
:param path: The path to the asset file or directory.
|
|
38167
38176
|
:param deploy_time: Whether or not the asset needs to exist beyond deployment time; i.e. are copied over to a different location and not needed afterwards. Setting this property to true has an impact on the lifecycle of the asset, because we will assume that it is safe to delete after the CloudFormation deployment succeeds. For example, Lambda Function assets are copied over to Lambda during deployment. Therefore, it is not necessary to store the asset in S3, so we consider those deployTime assets. Default: false
|
|
38168
38177
|
:param readers: A list of principals that should be able to read this asset from S3. You can use ``asset.grantRead(principal)`` to grant read permissions later. Default: - No principals that can read file asset.
|
|
38178
|
+
:param source_kms_key: The ARN of the KMS key used to encrypt the handler code. Default: - the default server-side encryption with Amazon S3 managed keys(SSE-S3) key will be used.
|
|
38169
38179
|
:param asset_hash: Specify a custom hash for this asset. If ``assetHashType`` is set it must be set to ``AssetHashType.CUSTOM``. For consistency, this custom hash will be SHA256 hashed and encoded as hex. The resulting hash will be the asset hash. NOTE: the hash is used in order to identify a specific revision of the asset, and used for optimizing and caching deployment activities related to this asset such as packaging, uploading to Amazon S3, etc. If you chose to customize the hash, you will need to make sure it is updated every time the asset changes, or otherwise it is possible that some deployments will not be invalidated. Default: - based on ``assetHashType``
|
|
38170
38180
|
:param asset_hash_type: Specifies the type of hash to calculate for this asset. If ``assetHash`` is configured, this option must be ``undefined`` or ``AssetHashType.CUSTOM``. Default: - the default is ``AssetHashType.SOURCE``, but if ``assetHash`` is explicitly specified this value defaults to ``AssetHashType.CUSTOM``.
|
|
38171
38181
|
:param bundling: Bundle the asset by executing a command in a Docker container or a custom bundling provider. The asset path will be mounted at ``/asset-input``. The Docker container is responsible for putting content at ``/asset-output``. The content at ``/asset-output`` will be zipped and used as the final asset. Default: - uploaded as-is to S3 if the asset is a regular file or a .zip file, archived into a .zip file and uploaded to S3 otherwise
|
|
@@ -38179,6 +38189,7 @@ class AssetEnvironmentFile(
|
|
|
38179
38189
|
options = _AssetOptions_2aa69621(
|
|
38180
38190
|
deploy_time=deploy_time,
|
|
38181
38191
|
readers=readers,
|
|
38192
|
+
source_kms_key=source_kms_key,
|
|
38182
38193
|
asset_hash=asset_hash,
|
|
38183
38194
|
asset_hash_type=asset_hash_type,
|
|
38184
38195
|
bundling=bundling,
|
|
@@ -44195,6 +44206,7 @@ def _typecheckingstub__984c009064fe3ececa2babfa7da070310c1a07aad5d8719d7817aacaf
|
|
|
44195
44206
|
*,
|
|
44196
44207
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
44197
44208
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
44209
|
+
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
44198
44210
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
44199
44211
|
asset_hash_type: typing.Optional[_AssetHashType_05b67f2d] = None,
|
|
44200
44212
|
bundling: typing.Optional[typing.Union[_BundlingOptions_588cc936, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -45472,6 +45484,7 @@ def _typecheckingstub__0c2450ee3cfe92be6dcc8ab1f8c7f9bc88382905f44289ab29eb782fb
|
|
|
45472
45484
|
*,
|
|
45473
45485
|
deploy_time: typing.Optional[builtins.bool] = None,
|
|
45474
45486
|
readers: typing.Optional[typing.Sequence[_IGrantable_71c4f5de]] = None,
|
|
45487
|
+
source_kms_key: typing.Optional[_IKey_5f11635f] = None,
|
|
45475
45488
|
asset_hash: typing.Optional[builtins.str] = None,
|
|
45476
45489
|
asset_hash_type: typing.Optional[_AssetHashType_05b67f2d] = None,
|
|
45477
45490
|
bundling: typing.Optional[typing.Union[_BundlingOptions_588cc936, typing.Dict[builtins.str, typing.Any]]] = None,
|
|
@@ -1680,7 +1680,7 @@ class CfnGlobalReplicationGroup(
|
|
|
1680
1680
|
:param automatic_failover_enabled: Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. ``AutomaticFailoverEnabled`` must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.
|
|
1681
1681
|
:param cache_node_type: The cache node type of the Global datastore.
|
|
1682
1682
|
:param cache_parameter_group_name: The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
|
|
1683
|
-
:param engine: The engine
|
|
1683
|
+
:param engine: The ElastiCache engine. For Valkey or Redis OSS only.
|
|
1684
1684
|
:param engine_version: The Elasticache Valkey or Redis OSS engine version.
|
|
1685
1685
|
:param global_node_group_count: The number of node groups that comprise the Global Datastore.
|
|
1686
1686
|
:param global_replication_group_description: The optional description of the Global datastore.
|
|
@@ -1826,7 +1826,7 @@ class CfnGlobalReplicationGroup(
|
|
|
1826
1826
|
@builtins.property
|
|
1827
1827
|
@jsii.member(jsii_name="engine")
|
|
1828
1828
|
def engine(self) -> typing.Optional[builtins.str]:
|
|
1829
|
-
'''The engine
|
|
1829
|
+
'''The ElastiCache engine.'''
|
|
1830
1830
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "engine"))
|
|
1831
1831
|
|
|
1832
1832
|
@engine.setter
|
|
@@ -2210,7 +2210,7 @@ class CfnGlobalReplicationGroupProps:
|
|
|
2210
2210
|
:param automatic_failover_enabled: Specifies whether a read-only replica is automatically promoted to read/write primary if the existing primary fails. ``AutomaticFailoverEnabled`` must be enabled for Valkey or Redis OSS (cluster mode enabled) replication groups.
|
|
2211
2211
|
:param cache_node_type: The cache node type of the Global datastore.
|
|
2212
2212
|
:param cache_parameter_group_name: The name of the cache parameter group to use with the Global datastore. It must be compatible with the major engine version used by the Global datastore.
|
|
2213
|
-
:param engine: The engine
|
|
2213
|
+
:param engine: The ElastiCache engine. For Valkey or Redis OSS only.
|
|
2214
2214
|
:param engine_version: The Elasticache Valkey or Redis OSS engine version.
|
|
2215
2215
|
:param global_node_group_count: The number of node groups that comprise the Global Datastore.
|
|
2216
2216
|
:param global_replication_group_description: The optional description of the Global datastore.
|
|
@@ -2333,7 +2333,9 @@ class CfnGlobalReplicationGroupProps:
|
|
|
2333
2333
|
|
|
2334
2334
|
@builtins.property
|
|
2335
2335
|
def engine(self) -> typing.Optional[builtins.str]:
|
|
2336
|
-
'''The engine
|
|
2336
|
+
'''The ElastiCache engine.
|
|
2337
|
+
|
|
2338
|
+
For Valkey or Redis OSS only.
|
|
2337
2339
|
|
|
2338
2340
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-globalreplicationgroup.html#cfn-elasticache-globalreplicationgroup-engine
|
|
2339
2341
|
'''
|
|
@@ -2851,7 +2853,7 @@ class CfnReplicationGroup(
|
|
|
2851
2853
|
:param cache_subnet_group_name: The name of the cache subnet group to be used for the replication group. .. epigraph:: If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see `AWS::ElastiCache::SubnetGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html>`_ .
|
|
2852
2854
|
:param cluster_mode: Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see `Modify cluster mode <https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/modify-cluster-mode.html>`_ .
|
|
2853
2855
|
:param data_tiering_enabled: Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see `Data tiering <https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/data-tiering.html>`_ .
|
|
2854
|
-
:param engine: The name of the cache engine to be used for the clusters in this replication group. The value must be set to ``valkey`` or ``redis`` .
|
|
2856
|
+
:param engine: The name of the cache engine to be used for the clusters in this replication group. The value must be set to ``valkey`` or ``redis`` . .. epigraph:: Upgrading an existing engine from redis to valkey is done through in-place migration, and requires a parameter group.
|
|
2855
2857
|
:param engine_version: The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the ``DescribeCacheEngineVersions`` operation. *Important:* You can upgrade to a newer engine version (see `Selecting a Cache Engine and Version <https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement>`_ ) in the *ElastiCache User Guide* , but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
|
|
2856
2858
|
:param global_replication_group_id: The name of the Global datastore.
|
|
2857
2859
|
:param ip_discovery: The network type you choose when creating a replication group, either ``ipv4`` | ``ipv6`` . IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the `Nitro system <https://docs.aws.amazon.com/ec2/nitro/>`_ .
|
|
@@ -2876,7 +2878,7 @@ class CfnReplicationGroup(
|
|
|
2876
2878
|
:param snapshotting_cluster_id: The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.
|
|
2877
2879
|
:param snapshot_window: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: ``05:00-09:00`` If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
|
|
2878
2880
|
:param tags: A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key= ``myKey`` , Value= ``myKeyValue`` . You can include multiple tags as shown following: Key= ``myKey`` , Value= ``myKeyValue`` Key= ``mySecondKey`` , Value= ``mySecondKeyValue`` . Tags on replication groups will be replicated to all nodes.
|
|
2879
|
-
:param transit_encryption_enabled: A flag that enables in-transit encryption when set to ``true`` . You cannot modify the value of ``TransitEncryptionEnabled`` after the cluster is created. To enable in-transit encryption on a cluster you must set ``TransitEncryptionEnabled`` to ``true`` when you create a cluster. This parameter is valid only if the ``Engine`` parameter is ``redis`` , the ``EngineVersion`` parameter is ``3.2.6`` or ``4.x`` onward, and the cluster is being created in an Amazon VPC. If you enable in-transit encryption, you must also specify a value for ``CacheSubnetGroup`` .
|
|
2881
|
+
:param transit_encryption_enabled: A flag that enables in-transit encryption when set to ``true`` . You cannot modify the value of ``TransitEncryptionEnabled`` after the cluster is created. To enable in-transit encryption on a cluster you must set ``TransitEncryptionEnabled`` to ``true`` when you create a cluster. This parameter is valid only if the ``Engine`` parameter is ``redis`` , the ``EngineVersion`` parameter is ``3.2.6`` or ``4.x`` onward, and the cluster is being created in an Amazon VPC. If you enable in-transit encryption, you must also specify a value for ``CacheSubnetGroup`` . .. epigraph:: - TransitEncryptionEnabled is only available when creating a replication group in an Amazon VPC using Valkey version ``7.2`` and above, Redis OSS version ``3.2.6`` , or Redis OSS version ``4.x`` and above. - TransitEncryptionEnabled is required when creating a new valkey replication group. Default: ``false`` .. epigraph:: For HIPAA compliance, you must specify ``TransitEncryptionEnabled`` as ``true`` , an ``AuthToken`` , and a ``CacheSubnetGroup`` .
|
|
2880
2882
|
:param transit_encryption_mode: A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. When setting ``TransitEncryptionEnabled`` to ``true`` , you can set your ``TransitEncryptionMode`` to ``preferred`` in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to ``required`` to allow encrypted connections only. Setting ``TransitEncryptionMode`` to ``required`` is a two-step process that requires you to first set the ``TransitEncryptionMode`` to ``preferred`` , after that you can set ``TransitEncryptionMode`` to ``required`` . This process will not trigger the replacement of the replication group.
|
|
2881
2883
|
:param user_group_ids: The ID of user group to associate with the replication group.
|
|
2882
2884
|
'''
|
|
@@ -4179,7 +4181,7 @@ class CfnReplicationGroupProps:
|
|
|
4179
4181
|
:param cache_subnet_group_name: The name of the cache subnet group to be used for the replication group. .. epigraph:: If you're going to launch your cluster in an Amazon VPC, you need to create a subnet group before you start creating a cluster. For more information, see `AWS::ElastiCache::SubnetGroup <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-elasticache-subnetgroup.html>`_ .
|
|
4180
4182
|
:param cluster_mode: Enabled or Disabled. To modify cluster mode from Disabled to Enabled, you must first set the cluster mode to Compatible. Compatible mode allows your Valkey or Redis OSS clients to connect using both cluster mode enabled and cluster mode disabled. After you migrate all Valkey or Redis OSS clients to use cluster mode enabled, you can then complete cluster mode configuration and set the cluster mode to Enabled. For more information, see `Modify cluster mode <https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/modify-cluster-mode.html>`_ .
|
|
4181
4183
|
:param data_tiering_enabled: Enables data tiering. Data tiering is only supported for replication groups using the r6gd node type. This parameter must be set to true when using r6gd nodes. For more information, see `Data tiering <https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/data-tiering.html>`_ .
|
|
4182
|
-
:param engine: The name of the cache engine to be used for the clusters in this replication group. The value must be set to ``valkey`` or ``redis`` .
|
|
4184
|
+
:param engine: The name of the cache engine to be used for the clusters in this replication group. The value must be set to ``valkey`` or ``redis`` . .. epigraph:: Upgrading an existing engine from redis to valkey is done through in-place migration, and requires a parameter group.
|
|
4183
4185
|
:param engine_version: The version number of the cache engine to be used for the clusters in this replication group. To view the supported cache engine versions, use the ``DescribeCacheEngineVersions`` operation. *Important:* You can upgrade to a newer engine version (see `Selecting a Cache Engine and Version <https://docs.aws.amazon.com/AmazonElastiCache/latest/dg/SelectEngine.html#VersionManagement>`_ ) in the *ElastiCache User Guide* , but you cannot downgrade to an earlier engine version. If you want to use an earlier engine version, you must delete the existing cluster or replication group and create it anew with the earlier engine version.
|
|
4184
4186
|
:param global_replication_group_id: The name of the Global datastore.
|
|
4185
4187
|
:param ip_discovery: The network type you choose when creating a replication group, either ``ipv4`` | ``ipv6`` . IPv6 is supported for workloads using Valkey 7.2 and above, Redis OSS engine version 6.2 and above or Memcached engine version 1.6.6 and above on all instances built on the `Nitro system <https://docs.aws.amazon.com/ec2/nitro/>`_ .
|
|
@@ -4204,7 +4206,7 @@ class CfnReplicationGroupProps:
|
|
|
4204
4206
|
:param snapshotting_cluster_id: The cluster ID that is used as the daily snapshot source for the replication group. This parameter cannot be set for Valkey or Redis OSS (cluster mode enabled) replication groups.
|
|
4205
4207
|
:param snapshot_window: The daily time range (in UTC) during which ElastiCache begins taking a daily snapshot of your node group (shard). Example: ``05:00-09:00`` If you do not specify this parameter, ElastiCache automatically chooses an appropriate time range.
|
|
4206
4208
|
:param tags: A list of tags to be added to this resource. Tags are comma-separated key,value pairs (e.g. Key= ``myKey`` , Value= ``myKeyValue`` . You can include multiple tags as shown following: Key= ``myKey`` , Value= ``myKeyValue`` Key= ``mySecondKey`` , Value= ``mySecondKeyValue`` . Tags on replication groups will be replicated to all nodes.
|
|
4207
|
-
:param transit_encryption_enabled: A flag that enables in-transit encryption when set to ``true`` . You cannot modify the value of ``TransitEncryptionEnabled`` after the cluster is created. To enable in-transit encryption on a cluster you must set ``TransitEncryptionEnabled`` to ``true`` when you create a cluster. This parameter is valid only if the ``Engine`` parameter is ``redis`` , the ``EngineVersion`` parameter is ``3.2.6`` or ``4.x`` onward, and the cluster is being created in an Amazon VPC. If you enable in-transit encryption, you must also specify a value for ``CacheSubnetGroup`` .
|
|
4209
|
+
:param transit_encryption_enabled: A flag that enables in-transit encryption when set to ``true`` . You cannot modify the value of ``TransitEncryptionEnabled`` after the cluster is created. To enable in-transit encryption on a cluster you must set ``TransitEncryptionEnabled`` to ``true`` when you create a cluster. This parameter is valid only if the ``Engine`` parameter is ``redis`` , the ``EngineVersion`` parameter is ``3.2.6`` or ``4.x`` onward, and the cluster is being created in an Amazon VPC. If you enable in-transit encryption, you must also specify a value for ``CacheSubnetGroup`` . .. epigraph:: - TransitEncryptionEnabled is only available when creating a replication group in an Amazon VPC using Valkey version ``7.2`` and above, Redis OSS version ``3.2.6`` , or Redis OSS version ``4.x`` and above. - TransitEncryptionEnabled is required when creating a new valkey replication group. Default: ``false`` .. epigraph:: For HIPAA compliance, you must specify ``TransitEncryptionEnabled`` as ``true`` , an ``AuthToken`` , and a ``CacheSubnetGroup`` .
|
|
4208
4210
|
:param transit_encryption_mode: A setting that allows you to migrate your clients to use in-transit encryption, with no downtime. When setting ``TransitEncryptionEnabled`` to ``true`` , you can set your ``TransitEncryptionMode`` to ``preferred`` in the same request, to allow both encrypted and unencrypted connections at the same time. Once you migrate all your Valkey or Redis OSS clients to use encrypted connections you can modify the value to ``required`` to allow encrypted connections only. Setting ``TransitEncryptionMode`` to ``required`` is a two-step process that requires you to first set the ``TransitEncryptionMode`` to ``preferred`` , after that you can set ``TransitEncryptionMode`` to ``required`` . This process will not trigger the replacement of the replication group.
|
|
4209
4211
|
:param user_group_ids: The ID of user group to associate with the replication group.
|
|
4210
4212
|
|
|
@@ -4609,6 +4611,9 @@ class CfnReplicationGroupProps:
|
|
|
4609
4611
|
'''The name of the cache engine to be used for the clusters in this replication group.
|
|
4610
4612
|
|
|
4611
4613
|
The value must be set to ``valkey`` or ``redis`` .
|
|
4614
|
+
.. epigraph::
|
|
4615
|
+
|
|
4616
|
+
Upgrading an existing engine from redis to valkey is done through in-place migration, and requires a parameter group.
|
|
4612
4617
|
|
|
4613
4618
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-engine
|
|
4614
4619
|
'''
|
|
@@ -4935,8 +4940,10 @@ class CfnReplicationGroupProps:
|
|
|
4935
4940
|
This parameter is valid only if the ``Engine`` parameter is ``redis`` , the ``EngineVersion`` parameter is ``3.2.6`` or ``4.x`` onward, and the cluster is being created in an Amazon VPC.
|
|
4936
4941
|
|
|
4937
4942
|
If you enable in-transit encryption, you must also specify a value for ``CacheSubnetGroup`` .
|
|
4943
|
+
.. epigraph::
|
|
4938
4944
|
|
|
4939
|
-
|
|
4945
|
+
- TransitEncryptionEnabled is only available when creating a replication group in an Amazon VPC using Valkey version ``7.2`` and above, Redis OSS version ``3.2.6`` , or Redis OSS version ``4.x`` and above.
|
|
4946
|
+
- TransitEncryptionEnabled is required when creating a new valkey replication group.
|
|
4940
4947
|
|
|
4941
4948
|
Default: ``false``
|
|
4942
4949
|
.. epigraph::
|