aws-cdk-lib 2.196.0__py3-none-any.whl → 2.197.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 +2 -0
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.196.0.jsii.tgz → aws-cdk-lib@2.197.0.jsii.tgz} +0 -0
- aws_cdk/aws_apigateway/__init__.py +90 -1
- aws_cdk/aws_apigatewayv2/__init__.py +866 -0
- aws_cdk/aws_bedrock/__init__.py +32 -26
- aws_cdk/aws_cloudfront/__init__.py +9 -3
- aws_cdk/aws_cloudwatch/__init__.py +756 -29
- aws_cdk/aws_codebuild/__init__.py +19 -0
- aws_cdk/aws_codepipeline/__init__.py +42 -7
- aws_cdk/aws_datasync/__init__.py +43 -72
- aws_cdk/aws_datazone/__init__.py +615 -2
- aws_cdk/aws_deadline/__init__.py +139 -0
- aws_cdk/aws_dsql/__init__.py +35 -1
- aws_cdk/aws_ec2/__init__.py +81 -3
- aws_cdk/aws_ecs/__init__.py +24 -17
- aws_cdk/aws_elasticache/__init__.py +5 -5
- aws_cdk/aws_gamelift/__init__.py +103 -15
- aws_cdk/aws_gameliftstreams/__init__.py +6 -6
- aws_cdk/aws_lambda_nodejs/__init__.py +0 -6
- aws_cdk/aws_omics/__init__.py +920 -103
- aws_cdk/aws_route53resolver/__init__.py +0 -41
- aws_cdk/aws_ses/__init__.py +4 -4
- aws_cdk/aws_workspaces/__init__.py +39 -0
- {aws_cdk_lib-2.196.0.dist-info → aws_cdk_lib-2.197.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.196.0.dist-info → aws_cdk_lib-2.197.0.dist-info}/RECORD +30 -30
- {aws_cdk_lib-2.196.0.dist-info → aws_cdk_lib-2.197.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.196.0.dist-info → aws_cdk_lib-2.197.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.196.0.dist-info → aws_cdk_lib-2.197.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.196.0.dist-info → aws_cdk_lib-2.197.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_ecs/__init__.py
CHANGED
|
@@ -7560,8 +7560,8 @@ class CfnCluster(
|
|
|
7560
7560
|
) -> None:
|
|
7561
7561
|
'''The managed storage configuration for the cluster.
|
|
7562
7562
|
|
|
7563
|
-
:param fargate_ephemeral_storage_kms_key_id: Specify the AWS Key Management Service key ID for the Fargate ephemeral storage. The key must be a single Region key.
|
|
7564
|
-
:param kms_key_id: Specify a AWS Key Management Service key ID to encrypt
|
|
7563
|
+
:param fargate_ephemeral_storage_kms_key_id: Specify the AWS Key Management Service key ID for Fargate ephemeral storage. When you specify a ``fargateEphemeralStorageKmsKeyId`` , AWS Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see `Customer managed keys for AWS Fargate ephemeral storage for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-storage-encryption.html>`_ in the *Amazon Elastic Container Service Developer Guide* . The key must be a single Region key.
|
|
7564
|
+
:param kms_key_id: Specify a AWS Key Management Service key ID to encrypt Amazon ECS managed storage. When you specify a ``kmsKeyId`` , Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see `Encrypt data stored in Amazon EBS volumes for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html>`_ in the *Amazon Elastic Container Service Developer Guide* . The key must be a single Region key.
|
|
7565
7565
|
|
|
7566
7566
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-cluster-managedstorageconfiguration.html
|
|
7567
7567
|
:exampleMetadata: fixture=_generated
|
|
@@ -7589,7 +7589,9 @@ class CfnCluster(
|
|
|
7589
7589
|
|
|
7590
7590
|
@builtins.property
|
|
7591
7591
|
def fargate_ephemeral_storage_kms_key_id(self) -> typing.Optional[builtins.str]:
|
|
7592
|
-
'''Specify the AWS Key Management Service key ID for
|
|
7592
|
+
'''Specify the AWS Key Management Service key ID for Fargate ephemeral storage.
|
|
7593
|
+
|
|
7594
|
+
When you specify a ``fargateEphemeralStorageKmsKeyId`` , AWS Fargate uses the key to encrypt data at rest in ephemeral storage. For more information about Fargate ephemeral storage encryption, see `Customer managed keys for AWS Fargate ephemeral storage for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/fargate-storage-encryption.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
7593
7595
|
|
|
7594
7596
|
The key must be a single Region key.
|
|
7595
7597
|
|
|
@@ -7600,7 +7602,9 @@ class CfnCluster(
|
|
|
7600
7602
|
|
|
7601
7603
|
@builtins.property
|
|
7602
7604
|
def kms_key_id(self) -> typing.Optional[builtins.str]:
|
|
7603
|
-
'''Specify a AWS Key Management Service key ID to encrypt
|
|
7605
|
+
'''Specify a AWS Key Management Service key ID to encrypt Amazon ECS managed storage.
|
|
7606
|
+
|
|
7607
|
+
When you specify a ``kmsKeyId`` , Amazon ECS uses the key to encrypt data volumes managed by Amazon ECS that are attached to tasks in the cluster. The following data volumes are managed by Amazon ECS: Amazon EBS. For more information about encryption of Amazon EBS volumes attached to Amazon ECS tasks, see `Encrypt data stored in Amazon EBS volumes for Amazon ECS <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
7604
7608
|
|
|
7605
7609
|
The key must be a single Region key.
|
|
7606
7610
|
|
|
@@ -11176,15 +11180,15 @@ class CfnService(
|
|
|
11176
11180
|
Many of these parameters map 1:1 with the Amazon EBS ``CreateVolume`` API request parameters.
|
|
11177
11181
|
|
|
11178
11182
|
: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* .
|
|
11179
|
-
:param encrypted: Indicates whether the volume should be encrypted. If
|
|
11180
|
-
: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
|
|
11183
|
+
:param encrypted: Indicates whether the volume should be encrypted. If you turn on Region-level Amazon EBS encryption by default but set this value as ``false`` , the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption 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* .
|
|
11184
|
+
: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 tasks 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`` .
|
|
11181
11185
|
: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* .
|
|
11182
|
-
:param kms_key_id: The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When
|
|
11186
|
+
:param kms_key_id: The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption. When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. 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* . For more information about encrypting Amazon EBS volumes attached to tasks, see `Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html>`_ . .. 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.
|
|
11183
11187
|
: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
|
|
11184
|
-
:param snapshot_id: The snapshot that Amazon ECS uses to create the
|
|
11188
|
+
:param snapshot_id: The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service. You must specify either ``snapshotId`` or ``sizeInGiB`` in your volume configuration. This parameter maps 1:1 with the ``SnapshotId`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`_ in the *Amazon EC2 API Reference* .
|
|
11185
11189
|
:param tag_specifications: The tags to apply to the volume. Amazon ECS applies service-managed tags by default. This parameter maps 1:1 with the ``TagSpecifications.N`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`_ in the *Amazon EC2 API Reference* .
|
|
11186
11190
|
:param throughput: The throughput to provision for a volume, in MiB/s, with a maximum of 1,000 MiB/s. This parameter maps 1:1 with the ``Throughput`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`_ in the *Amazon EC2 API Reference* . .. epigraph:: This parameter is only supported for the ``gp3`` volume type.
|
|
11187
|
-
:param volume_initialization_rate:
|
|
11191
|
+
:param volume_initialization_rate: The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service. This property can be specified only if you specify a ``snapshotId`` . For more information, see `Initialize Amazon EBS volumes <https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html>`_ in the *Amazon EBS User Guide* .
|
|
11188
11192
|
:param volume_type: The volume type. This parameter maps 1:1 with the ``VolumeType`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`_ in the *Amazon EC2 API Reference* . For more information, see `Amazon EBS volume types <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-volume-types.html>`_ in the *Amazon EC2 User Guide* . The following are the supported volume types. - General Purpose SSD: ``gp2`` | ``gp3`` - Provisioned IOPS SSD: ``io1`` | ``io2`` - Throughput Optimized HDD: ``st1`` - Cold HDD: ``sc1`` - Magnetic: ``standard`` .. epigraph:: The magnetic volume type is not supported on Fargate.
|
|
11189
11193
|
|
|
11190
11194
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html
|
|
@@ -11276,7 +11280,7 @@ class CfnService(
|
|
|
11276
11280
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
11277
11281
|
'''Indicates whether the volume should be encrypted.
|
|
11278
11282
|
|
|
11279
|
-
If
|
|
11283
|
+
If you turn on Region-level Amazon EBS encryption by default but set this value as ``false`` , the setting is overridden and the volume is encrypted with the KMS key specified for Amazon EBS encryption 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* .
|
|
11280
11284
|
|
|
11281
11285
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-encrypted
|
|
11282
11286
|
'''
|
|
@@ -11287,7 +11291,7 @@ class CfnService(
|
|
|
11287
11291
|
def filesystem_type(self) -> typing.Optional[builtins.str]:
|
|
11288
11292
|
'''The filesystem type for the volume.
|
|
11289
11293
|
|
|
11290
|
-
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
|
|
11294
|
+
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 tasks will fail to start.
|
|
11291
11295
|
|
|
11292
11296
|
The available Linux filesystem types are ``ext3`` , ``ext4`` , and ``xfs`` . If no value is specified, the ``xfs`` filesystem type is used by default.
|
|
11293
11297
|
|
|
@@ -11323,7 +11327,7 @@ class CfnService(
|
|
|
11323
11327
|
def kms_key_id(self) -> typing.Optional[builtins.str]:
|
|
11324
11328
|
'''The Amazon Resource Name (ARN) identifier of the AWS Key Management Service key to use for Amazon EBS encryption.
|
|
11325
11329
|
|
|
11326
|
-
When
|
|
11330
|
+
When a key is specified using this parameter, it overrides Amazon EBS default encryption or any KMS key that you specified for cluster-level managed storage encryption. 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* . For more information about encrypting Amazon EBS volumes attached to tasks, see `Encrypt data stored in Amazon EBS volumes attached to Amazon ECS tasks <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ebs-kms-encryption.html>`_ .
|
|
11327
11331
|
.. epigraph::
|
|
11328
11332
|
|
|
11329
11333
|
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.
|
|
@@ -11353,9 +11357,9 @@ class CfnService(
|
|
|
11353
11357
|
|
|
11354
11358
|
@builtins.property
|
|
11355
11359
|
def snapshot_id(self) -> typing.Optional[builtins.str]:
|
|
11356
|
-
'''The snapshot that Amazon ECS uses to create the
|
|
11360
|
+
'''The snapshot that Amazon ECS uses to create volumes for attachment to tasks maintained by the service.
|
|
11357
11361
|
|
|
11358
|
-
You must specify either
|
|
11362
|
+
You must specify either ``snapshotId`` or ``sizeInGiB`` in your volume configuration. This parameter maps 1:1 with the ``SnapshotId`` parameter of the `CreateVolume API <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_CreateVolume.html>`_ in the *Amazon EC2 API Reference* .
|
|
11359
11363
|
|
|
11360
11364
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-snapshotid
|
|
11361
11365
|
'''
|
|
@@ -11391,7 +11395,10 @@ class CfnService(
|
|
|
11391
11395
|
|
|
11392
11396
|
@builtins.property
|
|
11393
11397
|
def volume_initialization_rate(self) -> typing.Optional[jsii.Number]:
|
|
11394
|
-
'''
|
|
11398
|
+
'''The rate, in MiB/s, at which data is fetched from a snapshot of an existing EBS volume to create new volumes for attachment to the tasks maintained by the service.
|
|
11399
|
+
|
|
11400
|
+
This property can be specified only if you specify a ``snapshotId`` . For more information, see `Initialize Amazon EBS volumes <https://docs.aws.amazon.com/ebs/latest/userguide/initalize-volume.html>`_ in the *Amazon EBS User Guide* .
|
|
11401
|
+
|
|
11395
11402
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-service-servicemanagedebsvolumeconfiguration.html#cfn-ecs-service-servicemanagedebsvolumeconfiguration-volumeinitializationrate
|
|
11396
11403
|
'''
|
|
11397
11404
|
result = self._values.get("volume_initialization_rate")
|
|
@@ -16988,7 +16995,7 @@ class CfnTaskDefinition(
|
|
|
16988
16995
|
This parameter is not supported for Windows containers. > This parameter is only supported for tasks that are hosted on AWS Fargate if the tasks are using platform version ``1.4.0`` or later (Linux). This isn't supported for Windows containers on Fargate.
|
|
16989
16996
|
|
|
16990
16997
|
:param namespace: The namespaced kernel parameter to set a ``value`` for.
|
|
16991
|
-
:param value: The namespaced kernel parameter to set a ``value`` for. Valid IPC namespace values: ``"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"`` , and ``Sysctls`` that start with ``"fs.mqueue.*"`` Valid network namespace values: ``Sysctls`` that start with ``"net.*"`` All of these values are supported by Fargate.
|
|
16998
|
+
:param value: The namespaced kernel parameter to set a ``value`` for. Valid IPC namespace values: ``"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"`` , and ``Sysctls`` that start with ``"fs.mqueue.*"`` Valid network namespace values: ``Sysctls`` that start with ``"net.*"`` . Only namespaced ``Sysctls`` that exist within the container starting with "net.* are accepted. All of these values are supported by Fargate.
|
|
16992
16999
|
|
|
16993
17000
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-taskdefinition-systemcontrol.html
|
|
16994
17001
|
:exampleMetadata: fixture=_generated
|
|
@@ -17029,7 +17036,7 @@ class CfnTaskDefinition(
|
|
|
17029
17036
|
|
|
17030
17037
|
Valid IPC namespace values: ``"kernel.msgmax" | "kernel.msgmnb" | "kernel.msgmni" | "kernel.sem" | "kernel.shmall" | "kernel.shmmax" | "kernel.shmmni" | "kernel.shm_rmid_forced"`` , and ``Sysctls`` that start with ``"fs.mqueue.*"``
|
|
17031
17038
|
|
|
17032
|
-
Valid network namespace values: ``Sysctls`` that start with ``"net.*"``
|
|
17039
|
+
Valid network namespace values: ``Sysctls`` that start with ``"net.*"`` . Only namespaced ``Sysctls`` that exist within the container starting with "net.* are accepted.
|
|
17033
17040
|
|
|
17034
17041
|
All of these values are supported by Fargate.
|
|
17035
17042
|
|
|
@@ -2851,7 +2851,7 @@ class CfnReplicationGroup(
|
|
|
2851
2851
|
:param cache_parameter_group_name: The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. If you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. - To create a Valkey or Redis OSS (cluster mode disabled) replication group, use ``CacheParameterGroupName=default.redis3.2`` . - To create a Valkey or Redis OSS (cluster mode enabled) replication group, use ``CacheParameterGroupName=default.redis3.2.cluster.on`` .
|
|
2852
2852
|
:param cache_security_group_names: A list of cache security group names to associate with this replication group.
|
|
2853
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>`_ .
|
|
2854
|
-
:param cluster_mode:
|
|
2854
|
+
:param cluster_mode: The mode can be enabled or disabled. To change the cluster mode from disabled to enabled, you must first set the cluster mode to compatible. The 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>`_ .
|
|
2855
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>`_ .
|
|
2856
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.
|
|
2857
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.
|
|
@@ -3211,7 +3211,7 @@ class CfnReplicationGroup(
|
|
|
3211
3211
|
@builtins.property
|
|
3212
3212
|
@jsii.member(jsii_name="clusterMode")
|
|
3213
3213
|
def cluster_mode(self) -> typing.Optional[builtins.str]:
|
|
3214
|
-
'''
|
|
3214
|
+
'''The mode can be enabled or disabled.'''
|
|
3215
3215
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "clusterMode"))
|
|
3216
3216
|
|
|
3217
3217
|
@cluster_mode.setter
|
|
@@ -4179,7 +4179,7 @@ class CfnReplicationGroupProps:
|
|
|
4179
4179
|
:param cache_parameter_group_name: The name of the parameter group to associate with this replication group. If this argument is omitted, the default cache parameter group for the specified engine is used. If you are running Valkey or Redis OSS version 3.2.4 or later, only one node group (shard), and want to use a default parameter group, we recommend that you specify the parameter group by name. - To create a Valkey or Redis OSS (cluster mode disabled) replication group, use ``CacheParameterGroupName=default.redis3.2`` . - To create a Valkey or Redis OSS (cluster mode enabled) replication group, use ``CacheParameterGroupName=default.redis3.2.cluster.on`` .
|
|
4180
4180
|
:param cache_security_group_names: A list of cache security group names to associate with this replication group.
|
|
4181
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>`_ .
|
|
4182
|
-
:param cluster_mode:
|
|
4182
|
+
:param cluster_mode: The mode can be enabled or disabled. To change the cluster mode from disabled to enabled, you must first set the cluster mode to compatible. The 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>`_ .
|
|
4183
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>`_ .
|
|
4184
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.
|
|
4185
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.
|
|
@@ -4582,9 +4582,9 @@ class CfnReplicationGroupProps:
|
|
|
4582
4582
|
|
|
4583
4583
|
@builtins.property
|
|
4584
4584
|
def cluster_mode(self) -> typing.Optional[builtins.str]:
|
|
4585
|
-
'''
|
|
4585
|
+
'''The mode can be enabled or disabled.
|
|
4586
4586
|
|
|
4587
|
-
To
|
|
4587
|
+
To change the cluster mode from disabled to enabled, you must first set the cluster mode to compatible. The 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>`_ .
|
|
4588
4588
|
|
|
4589
4589
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-elasticache-replicationgroup.html#cfn-elasticache-replicationgroup-clustermode
|
|
4590
4590
|
'''
|
aws_cdk/aws_gamelift/__init__.py
CHANGED
|
@@ -4655,7 +4655,7 @@ class CfnContainerGroupDefinitionProps:
|
|
|
4655
4655
|
)
|
|
4656
4656
|
|
|
4657
4657
|
|
|
4658
|
-
@jsii.implements(_IInspectable_c2943556)
|
|
4658
|
+
@jsii.implements(_IInspectable_c2943556, _ITaggableV2_4e6798f8)
|
|
4659
4659
|
class CfnFleet(
|
|
4660
4660
|
_CfnResource_9df397a6,
|
|
4661
4661
|
metaclass=jsii.JSIIMeta,
|
|
@@ -4752,7 +4752,11 @@ class CfnFleet(
|
|
|
4752
4752
|
)],
|
|
4753
4753
|
script_id="scriptId",
|
|
4754
4754
|
server_launch_parameters="serverLaunchParameters",
|
|
4755
|
-
server_launch_path="serverLaunchPath"
|
|
4755
|
+
server_launch_path="serverLaunchPath",
|
|
4756
|
+
tags=[CfnTag(
|
|
4757
|
+
key="key",
|
|
4758
|
+
value="value"
|
|
4759
|
+
)]
|
|
4756
4760
|
)
|
|
4757
4761
|
'''
|
|
4758
4762
|
|
|
@@ -4788,6 +4792,7 @@ class CfnFleet(
|
|
|
4788
4792
|
script_id: typing.Optional[builtins.str] = None,
|
|
4789
4793
|
server_launch_parameters: typing.Optional[builtins.str] = None,
|
|
4790
4794
|
server_launch_path: typing.Optional[builtins.str] = None,
|
|
4795
|
+
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
4791
4796
|
) -> None:
|
|
4792
4797
|
'''
|
|
4793
4798
|
:param scope: Scope in which this resource is defined.
|
|
@@ -4799,7 +4804,7 @@ class CfnFleet(
|
|
|
4799
4804
|
:param certificate_configuration: Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. Amazon GameLift Servers uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift Servers. By default, the ``CertificateConfiguration`` is ``DISABLED`` . You can't change this property after you create the fleet. AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition. .. epigraph:: ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see `Supported Regions <https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html>`_ in the *AWS Certificate Manager User Guide* .
|
|
4800
4805
|
:param compute_type: The type of compute resource used to host your game servers. - ``EC2`` – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting. - ``ANYWHERE`` – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
|
|
4801
4806
|
:param description: A description for the fleet.
|
|
4802
|
-
:param desired_ec2_instances: The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
|
|
4807
|
+
:param desired_ec2_instances: (deprecated) The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
|
|
4803
4808
|
:param ec2_inbound_permissions: The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call ` <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings>`_ to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically sets TCP and UDP ranges.
|
|
4804
4809
|
:param ec2_instance_type: The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See `Amazon Elastic Compute Cloud Instance Types <https://docs.aws.amazon.com/ec2/instance-types/>`_ for detailed descriptions of Amazon EC2 instance types.
|
|
4805
4810
|
:param fleet_type: Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ``ON_DEMAND`` . Learn more about when to use `On-Demand versus Spot Instances <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot>`_ . This fleet property can't be changed after the fleet is created.
|
|
@@ -4807,9 +4812,9 @@ class CfnFleet(
|
|
|
4807
4812
|
:param instance_role_credentials_provider: Indicates that fleet instances maintain a shared credentials file for the IAM role defined in ``InstanceRoleArn`` . Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is ``EC2`` .
|
|
4808
4813
|
:param locations: A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more AWS Region codes, such as ``us-west-2`` , or Local Zone names. When using this parameter, Amazon GameLift Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see `Amazon GameLift Servers service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
4809
4814
|
:param log_paths: (deprecated) This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
|
|
4810
|
-
:param max_size: The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
|
|
4815
|
+
:param max_size: (deprecated) The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
|
|
4811
4816
|
:param metric_groups: The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
|
|
4812
|
-
:param min_size: The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
|
|
4817
|
+
:param min_size: (deprecated) The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
|
|
4813
4818
|
:param new_game_session_protection_policy: The status of termination protection for active game sessions on the fleet. By default, this property is set to ``NoProtection`` . - *NoProtection* - Game sessions can be terminated during active gameplay as a result of a scale-down event. - *FullProtection* - Game sessions in ``ACTIVE`` status cannot be terminated during a scale-down event.
|
|
4814
4819
|
:param peer_vpc_aws_account_id: Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC. You can find your account ID in the AWS Management Console under account settings.
|
|
4815
4820
|
:param peer_vpc_id: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the `VPC Dashboard <https://docs.aws.amazon.com/vpc/>`_ in the AWS Management Console . Learn more about VPC peering in `VPC Peering with Amazon GameLift Servers Fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html>`_ .
|
|
@@ -4819,6 +4824,7 @@ class CfnFleet(
|
|
|
4819
4824
|
:param script_id: The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift Servers prior to creating the fleet. This fleet property cannot be changed later. .. epigraph:: You can't use the ``!Ref`` command to reference a script created with a CloudFormation template for the fleet property ``ScriptId`` . Instead, use ``Fn::GetAtt Script.Arn`` or ``Fn::GetAtt Script.Id`` to retrieve either of these properties as input for ``ScriptId`` . Alternatively, enter a ``ScriptId`` string manually.
|
|
4820
4825
|
:param server_launch_parameters: (deprecated) This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
|
|
4821
4826
|
:param server_launch_path: (deprecated) This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
|
|
4827
|
+
:param tags: An array of key-value pairs to apply to this resource.
|
|
4822
4828
|
'''
|
|
4823
4829
|
if __debug__:
|
|
4824
4830
|
type_hints = typing.get_type_hints(_typecheckingstub__21fe09a90444788b3c862f454214d4e160757c9b02d0598d282f68b7f79d749f)
|
|
@@ -4852,6 +4858,7 @@ class CfnFleet(
|
|
|
4852
4858
|
script_id=script_id,
|
|
4853
4859
|
server_launch_parameters=server_launch_parameters,
|
|
4854
4860
|
server_launch_path=server_launch_path,
|
|
4861
|
+
tags=tags,
|
|
4855
4862
|
)
|
|
4856
4863
|
|
|
4857
4864
|
jsii.create(self.__class__, self, [scope, id, props])
|
|
@@ -4886,6 +4893,17 @@ class CfnFleet(
|
|
|
4886
4893
|
'''The CloudFormation resource type name for this resource class.'''
|
|
4887
4894
|
return typing.cast(builtins.str, jsii.sget(cls, "CFN_RESOURCE_TYPE_NAME"))
|
|
4888
4895
|
|
|
4896
|
+
@builtins.property
|
|
4897
|
+
@jsii.member(jsii_name="attrFleetArn")
|
|
4898
|
+
def attr_fleet_arn(self) -> builtins.str:
|
|
4899
|
+
'''The Amazon Resource Name (ARN) that is assigned to a Amazon GameLift Servers Fleet resource and uniquely identifies it.
|
|
4900
|
+
|
|
4901
|
+
ARNs are unique across all Regions. In a GameLift Fleet ARN, the resource ID matches the FleetId value.
|
|
4902
|
+
|
|
4903
|
+
:cloudformationAttribute: FleetArn
|
|
4904
|
+
'''
|
|
4905
|
+
return typing.cast(builtins.str, jsii.get(self, "attrFleetArn"))
|
|
4906
|
+
|
|
4889
4907
|
@builtins.property
|
|
4890
4908
|
@jsii.member(jsii_name="attrFleetId")
|
|
4891
4909
|
def attr_fleet_id(self) -> builtins.str:
|
|
@@ -4895,6 +4913,12 @@ class CfnFleet(
|
|
|
4895
4913
|
'''
|
|
4896
4914
|
return typing.cast(builtins.str, jsii.get(self, "attrFleetId"))
|
|
4897
4915
|
|
|
4916
|
+
@builtins.property
|
|
4917
|
+
@jsii.member(jsii_name="cdkTagManager")
|
|
4918
|
+
def cdk_tag_manager(self) -> _TagManager_0a598cb3:
|
|
4919
|
+
'''Tag Manager which manages the tags for this resource.'''
|
|
4920
|
+
return typing.cast(_TagManager_0a598cb3, jsii.get(self, "cdkTagManager"))
|
|
4921
|
+
|
|
4898
4922
|
@builtins.property
|
|
4899
4923
|
@jsii.member(jsii_name="cfnProperties")
|
|
4900
4924
|
def _cfn_properties(self) -> typing.Mapping[builtins.str, typing.Any]:
|
|
@@ -5004,7 +5028,12 @@ class CfnFleet(
|
|
|
5004
5028
|
@builtins.property
|
|
5005
5029
|
@jsii.member(jsii_name="desiredEc2Instances")
|
|
5006
5030
|
def desired_ec2_instances(self) -> typing.Optional[jsii.Number]:
|
|
5007
|
-
'''The number of EC2 instances that you want this fleet to host.
|
|
5031
|
+
'''(deprecated) The number of EC2 instances that you want this fleet to host.
|
|
5032
|
+
|
|
5033
|
+
:deprecated: this property has been deprecated
|
|
5034
|
+
|
|
5035
|
+
:stability: deprecated
|
|
5036
|
+
'''
|
|
5008
5037
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "desiredEc2Instances"))
|
|
5009
5038
|
|
|
5010
5039
|
@desired_ec2_instances.setter
|
|
@@ -5126,7 +5155,12 @@ class CfnFleet(
|
|
|
5126
5155
|
@builtins.property
|
|
5127
5156
|
@jsii.member(jsii_name="maxSize")
|
|
5128
5157
|
def max_size(self) -> typing.Optional[jsii.Number]:
|
|
5129
|
-
'''The maximum number of instances that are allowed in the specified fleet location.
|
|
5158
|
+
'''(deprecated) The maximum number of instances that are allowed in the specified fleet location.
|
|
5159
|
+
|
|
5160
|
+
:deprecated: this property has been deprecated
|
|
5161
|
+
|
|
5162
|
+
:stability: deprecated
|
|
5163
|
+
'''
|
|
5130
5164
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "maxSize"))
|
|
5131
5165
|
|
|
5132
5166
|
@max_size.setter
|
|
@@ -5152,7 +5186,12 @@ class CfnFleet(
|
|
|
5152
5186
|
@builtins.property
|
|
5153
5187
|
@jsii.member(jsii_name="minSize")
|
|
5154
5188
|
def min_size(self) -> typing.Optional[jsii.Number]:
|
|
5155
|
-
'''The minimum number of instances that are allowed in the specified fleet location.
|
|
5189
|
+
'''(deprecated) The minimum number of instances that are allowed in the specified fleet location.
|
|
5190
|
+
|
|
5191
|
+
:deprecated: this property has been deprecated
|
|
5192
|
+
|
|
5193
|
+
:stability: deprecated
|
|
5194
|
+
'''
|
|
5156
5195
|
return typing.cast(typing.Optional[jsii.Number], jsii.get(self, "minSize"))
|
|
5157
5196
|
|
|
5158
5197
|
@min_size.setter
|
|
@@ -5307,6 +5346,19 @@ class CfnFleet(
|
|
|
5307
5346
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
5308
5347
|
jsii.set(self, "serverLaunchPath", value) # pyright: ignore[reportArgumentType]
|
|
5309
5348
|
|
|
5349
|
+
@builtins.property
|
|
5350
|
+
@jsii.member(jsii_name="tags")
|
|
5351
|
+
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
5352
|
+
'''An array of key-value pairs to apply to this resource.'''
|
|
5353
|
+
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tags"))
|
|
5354
|
+
|
|
5355
|
+
@tags.setter
|
|
5356
|
+
def tags(self, value: typing.Optional[typing.List[_CfnTag_f6864754]]) -> None:
|
|
5357
|
+
if __debug__:
|
|
5358
|
+
type_hints = typing.get_type_hints(_typecheckingstub__27ef86cf1bf34b50ec355a45305857c52751912f8408dec34a63b8a26665856d)
|
|
5359
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
5360
|
+
jsii.set(self, "tags", value) # pyright: ignore[reportArgumentType]
|
|
5361
|
+
|
|
5310
5362
|
@jsii.data_type(
|
|
5311
5363
|
jsii_type="aws-cdk-lib.aws_gamelift.CfnFleet.AnywhereConfigurationProperty",
|
|
5312
5364
|
jsii_struct_bases=[],
|
|
@@ -6386,6 +6438,7 @@ class CfnFleet(
|
|
|
6386
6438
|
"script_id": "scriptId",
|
|
6387
6439
|
"server_launch_parameters": "serverLaunchParameters",
|
|
6388
6440
|
"server_launch_path": "serverLaunchPath",
|
|
6441
|
+
"tags": "tags",
|
|
6389
6442
|
},
|
|
6390
6443
|
)
|
|
6391
6444
|
class CfnFleetProps:
|
|
@@ -6419,6 +6472,7 @@ class CfnFleetProps:
|
|
|
6419
6472
|
script_id: typing.Optional[builtins.str] = None,
|
|
6420
6473
|
server_launch_parameters: typing.Optional[builtins.str] = None,
|
|
6421
6474
|
server_launch_path: typing.Optional[builtins.str] = None,
|
|
6475
|
+
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6422
6476
|
) -> None:
|
|
6423
6477
|
'''Properties for defining a ``CfnFleet``.
|
|
6424
6478
|
|
|
@@ -6429,7 +6483,7 @@ class CfnFleetProps:
|
|
|
6429
6483
|
:param certificate_configuration: Prompts Amazon GameLift Servers to generate a TLS/SSL certificate for the fleet. Amazon GameLift Servers uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift Servers. By default, the ``CertificateConfiguration`` is ``DISABLED`` . You can't change this property after you create the fleet. AWS Certificate Manager (ACM) certificates expire after 13 months. Certificate expiration can cause fleets to fail, preventing players from connecting to instances in the fleet. We recommend you replace fleets before 13 months, consider using fleet aliases for a smooth transition. .. epigraph:: ACM isn't available in all AWS regions. A fleet creation request with certificate generation enabled in an unsupported Region, fails with a 4xx error. For more information about the supported Regions, see `Supported Regions <https://docs.aws.amazon.com/acm/latest/userguide/acm-regions.html>`_ in the *AWS Certificate Manager User Guide* .
|
|
6430
6484
|
:param compute_type: The type of compute resource used to host your game servers. - ``EC2`` – The game server build is deployed to Amazon EC2 instances for cloud hosting. This is the default setting. - ``ANYWHERE`` – Game servers and supporting software are deployed to compute resources that you provide and manage. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
|
|
6431
6485
|
:param description: A description for the fleet.
|
|
6432
|
-
:param desired_ec2_instances: The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
|
|
6486
|
+
:param desired_ec2_instances: (deprecated) The number of EC2 instances that you want this fleet to host. When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
|
|
6433
6487
|
:param ec2_inbound_permissions: The IP address ranges and port settings that allow inbound traffic to access game server processes and other processes on this fleet. Set this parameter for managed EC2 fleets. You can leave this parameter empty when creating the fleet, but you must call ` <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetPortSettings>`_ to set it before players can connect to game sessions. As a best practice, we recommend opening ports for remote access only when you need them and closing them when you're finished. For Amazon GameLift Servers Realtime fleets, Amazon GameLift Servers automatically sets TCP and UDP ranges.
|
|
6434
6488
|
:param ec2_instance_type: The Amazon GameLift Servers-supported Amazon EC2 instance type to use with managed EC2 fleets. Instance type determines the computing resources that will be used to host your game servers, including CPU, memory, storage, and networking capacity. See `Amazon Elastic Compute Cloud Instance Types <https://docs.aws.amazon.com/ec2/instance-types/>`_ for detailed descriptions of Amazon EC2 instance types.
|
|
6435
6489
|
:param fleet_type: Indicates whether to use On-Demand or Spot instances for this fleet. By default, this property is set to ``ON_DEMAND`` . Learn more about when to use `On-Demand versus Spot Instances <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-ec2-instances.html#gamelift-ec2-instances-spot>`_ . This fleet property can't be changed after the fleet is created.
|
|
@@ -6437,9 +6491,9 @@ class CfnFleetProps:
|
|
|
6437
6491
|
:param instance_role_credentials_provider: Indicates that fleet instances maintain a shared credentials file for the IAM role defined in ``InstanceRoleArn`` . Shared credentials allow applications that are deployed with the game server executable to communicate with other AWS resources. This property is used only when the game server is integrated with the server SDK version 5.x. For more information about using shared credentials, see `Communicate with other AWS resources from your fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-sdk-server-resources.html>`_ . This attribute is used with fleets where ``ComputeType`` is ``EC2`` .
|
|
6438
6492
|
:param locations: A set of remote locations to deploy additional instances to and manage as a multi-location fleet. Use this parameter when creating a fleet in AWS Regions that support multiple locations. You can add any AWS Region or Local Zone that's supported by Amazon GameLift Servers. Provide a list of one or more AWS Region codes, such as ``us-west-2`` , or Local Zone names. When using this parameter, Amazon GameLift Servers requires you to include your home location in the request. For a list of supported Regions and Local Zones, see `Amazon GameLift Servers service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
6439
6493
|
:param log_paths: (deprecated) This parameter is no longer used. When hosting a custom game build, specify where Amazon GameLift should store log files using the Amazon GameLift server API call ProcessReady()
|
|
6440
|
-
:param max_size: The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
|
|
6494
|
+
:param max_size: (deprecated) The maximum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 1.
|
|
6441
6495
|
:param metric_groups: The name of an AWS CloudWatch metric group to add this fleet to. A metric group is used to aggregate the metrics for multiple fleets. You can specify an existing metric group name or set a new name to create a new metric group. A fleet can be included in only one metric group at a time.
|
|
6442
|
-
:param min_size: The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
|
|
6496
|
+
:param min_size: (deprecated) The minimum number of instances that are allowed in the specified fleet location. If this parameter is not set, the default is 0.
|
|
6443
6497
|
:param new_game_session_protection_policy: The status of termination protection for active game sessions on the fleet. By default, this property is set to ``NoProtection`` . - *NoProtection* - Game sessions can be terminated during active gameplay as a result of a scale-down event. - *FullProtection* - Game sessions in ``ACTIVE`` status cannot be terminated during a scale-down event.
|
|
6444
6498
|
:param peer_vpc_aws_account_id: Used when peering your Amazon GameLift Servers fleet with a VPC, the unique identifier for the AWS account that owns the VPC. You can find your account ID in the AWS Management Console under account settings.
|
|
6445
6499
|
:param peer_vpc_id: A unique identifier for a VPC with resources to be accessed by your Amazon GameLift Servers fleet. The VPC must be in the same Region as your fleet. To look up a VPC ID, use the `VPC Dashboard <https://docs.aws.amazon.com/vpc/>`_ in the AWS Management Console . Learn more about VPC peering in `VPC Peering with Amazon GameLift Servers Fleets <https://docs.aws.amazon.com/gamelift/latest/developerguide/vpc-peering.html>`_ .
|
|
@@ -6449,6 +6503,7 @@ class CfnFleetProps:
|
|
|
6449
6503
|
:param script_id: The unique identifier for a Realtime configuration script to be deployed on fleet instances. You can use either the script ID or ARN. Scripts must be uploaded to Amazon GameLift Servers prior to creating the fleet. This fleet property cannot be changed later. .. epigraph:: You can't use the ``!Ref`` command to reference a script created with a CloudFormation template for the fleet property ``ScriptId`` . Instead, use ``Fn::GetAtt Script.Arn`` or ``Fn::GetAtt Script.Id`` to retrieve either of these properties as input for ``ScriptId`` . Alternatively, enter a ``ScriptId`` string manually.
|
|
6450
6504
|
:param server_launch_parameters: (deprecated) This parameter is no longer used but is retained for backward compatibility. Instead, specify server launch parameters in the RuntimeConfiguration parameter. A request must specify either a runtime configuration or values for both ServerLaunchParameters and ServerLaunchPath.
|
|
6451
6505
|
:param server_launch_path: (deprecated) This parameter is no longer used. Instead, specify a server launch path using the RuntimeConfiguration parameter. Requests that specify a server launch path and launch parameters instead of a runtime configuration will continue to work.
|
|
6506
|
+
:param tags: An array of key-value pairs to apply to this resource.
|
|
6452
6507
|
|
|
6453
6508
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html
|
|
6454
6509
|
:exampleMetadata: fixture=_generated
|
|
@@ -6536,7 +6591,11 @@ class CfnFleetProps:
|
|
|
6536
6591
|
)],
|
|
6537
6592
|
script_id="scriptId",
|
|
6538
6593
|
server_launch_parameters="serverLaunchParameters",
|
|
6539
|
-
server_launch_path="serverLaunchPath"
|
|
6594
|
+
server_launch_path="serverLaunchPath",
|
|
6595
|
+
tags=[CfnTag(
|
|
6596
|
+
key="key",
|
|
6597
|
+
value="value"
|
|
6598
|
+
)]
|
|
6540
6599
|
)
|
|
6541
6600
|
'''
|
|
6542
6601
|
if __debug__:
|
|
@@ -6568,6 +6627,7 @@ class CfnFleetProps:
|
|
|
6568
6627
|
check_type(argname="argument script_id", value=script_id, expected_type=type_hints["script_id"])
|
|
6569
6628
|
check_type(argname="argument server_launch_parameters", value=server_launch_parameters, expected_type=type_hints["server_launch_parameters"])
|
|
6570
6629
|
check_type(argname="argument server_launch_path", value=server_launch_path, expected_type=type_hints["server_launch_path"])
|
|
6630
|
+
check_type(argname="argument tags", value=tags, expected_type=type_hints["tags"])
|
|
6571
6631
|
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
6572
6632
|
"name": name,
|
|
6573
6633
|
}
|
|
@@ -6623,6 +6683,8 @@ class CfnFleetProps:
|
|
|
6623
6683
|
self._values["server_launch_parameters"] = server_launch_parameters
|
|
6624
6684
|
if server_launch_path is not None:
|
|
6625
6685
|
self._values["server_launch_path"] = server_launch_path
|
|
6686
|
+
if tags is not None:
|
|
6687
|
+
self._values["tags"] = tags
|
|
6626
6688
|
|
|
6627
6689
|
@builtins.property
|
|
6628
6690
|
def name(self) -> builtins.str:
|
|
@@ -6712,11 +6774,14 @@ class CfnFleetProps:
|
|
|
6712
6774
|
|
|
6713
6775
|
@builtins.property
|
|
6714
6776
|
def desired_ec2_instances(self) -> typing.Optional[jsii.Number]:
|
|
6715
|
-
'''The number of EC2 instances that you want this fleet to host.
|
|
6777
|
+
'''(deprecated) The number of EC2 instances that you want this fleet to host.
|
|
6716
6778
|
|
|
6717
6779
|
When creating a new fleet, GameLift automatically sets this value to "1" and initiates a single instance. Once the fleet is active, update this value to trigger GameLift to add or remove instances from the fleet.
|
|
6718
6780
|
|
|
6781
|
+
:deprecated: this property has been deprecated
|
|
6782
|
+
|
|
6719
6783
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-desiredec2instances
|
|
6784
|
+
:stability: deprecated
|
|
6720
6785
|
'''
|
|
6721
6786
|
result = self._values.get("desired_ec2_instances")
|
|
6722
6787
|
return typing.cast(typing.Optional[jsii.Number], result)
|
|
@@ -6807,11 +6872,14 @@ class CfnFleetProps:
|
|
|
6807
6872
|
|
|
6808
6873
|
@builtins.property
|
|
6809
6874
|
def max_size(self) -> typing.Optional[jsii.Number]:
|
|
6810
|
-
'''The maximum number of instances that are allowed in the specified fleet location.
|
|
6875
|
+
'''(deprecated) The maximum number of instances that are allowed in the specified fleet location.
|
|
6811
6876
|
|
|
6812
6877
|
If this parameter is not set, the default is 1.
|
|
6813
6878
|
|
|
6879
|
+
:deprecated: this property has been deprecated
|
|
6880
|
+
|
|
6814
6881
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-maxsize
|
|
6882
|
+
:stability: deprecated
|
|
6815
6883
|
'''
|
|
6816
6884
|
result = self._values.get("max_size")
|
|
6817
6885
|
return typing.cast(typing.Optional[jsii.Number], result)
|
|
@@ -6829,11 +6897,14 @@ class CfnFleetProps:
|
|
|
6829
6897
|
|
|
6830
6898
|
@builtins.property
|
|
6831
6899
|
def min_size(self) -> typing.Optional[jsii.Number]:
|
|
6832
|
-
'''The minimum number of instances that are allowed in the specified fleet location.
|
|
6900
|
+
'''(deprecated) The minimum number of instances that are allowed in the specified fleet location.
|
|
6833
6901
|
|
|
6834
6902
|
If this parameter is not set, the default is 0.
|
|
6835
6903
|
|
|
6904
|
+
:deprecated: this property has been deprecated
|
|
6905
|
+
|
|
6836
6906
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-minsize
|
|
6907
|
+
:stability: deprecated
|
|
6837
6908
|
'''
|
|
6838
6909
|
result = self._values.get("min_size")
|
|
6839
6910
|
return typing.cast(typing.Optional[jsii.Number], result)
|
|
@@ -6956,6 +7027,15 @@ class CfnFleetProps:
|
|
|
6956
7027
|
result = self._values.get("server_launch_path")
|
|
6957
7028
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
6958
7029
|
|
|
7030
|
+
@builtins.property
|
|
7031
|
+
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
7032
|
+
'''An array of key-value pairs to apply to this resource.
|
|
7033
|
+
|
|
7034
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-tags
|
|
7035
|
+
'''
|
|
7036
|
+
result = self._values.get("tags")
|
|
7037
|
+
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], result)
|
|
7038
|
+
|
|
6959
7039
|
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
6960
7040
|
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
6961
7041
|
|
|
@@ -11207,6 +11287,7 @@ def _typecheckingstub__21fe09a90444788b3c862f454214d4e160757c9b02d0598d282f68b7f
|
|
|
11207
11287
|
script_id: typing.Optional[builtins.str] = None,
|
|
11208
11288
|
server_launch_parameters: typing.Optional[builtins.str] = None,
|
|
11209
11289
|
server_launch_path: typing.Optional[builtins.str] = None,
|
|
11290
|
+
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11210
11291
|
) -> None:
|
|
11211
11292
|
"""Type checking stubs"""
|
|
11212
11293
|
pass
|
|
@@ -11385,6 +11466,12 @@ def _typecheckingstub__63d5bf96be81c4a6b00ef1deb4d8846acf0053313fb89efd0ded1f093
|
|
|
11385
11466
|
"""Type checking stubs"""
|
|
11386
11467
|
pass
|
|
11387
11468
|
|
|
11469
|
+
def _typecheckingstub__27ef86cf1bf34b50ec355a45305857c52751912f8408dec34a63b8a26665856d(
|
|
11470
|
+
value: typing.Optional[typing.List[_CfnTag_f6864754]],
|
|
11471
|
+
) -> None:
|
|
11472
|
+
"""Type checking stubs"""
|
|
11473
|
+
pass
|
|
11474
|
+
|
|
11388
11475
|
def _typecheckingstub__e3897ffc82938e5bf4e6384b3a83b22f50c7189a71eb0fc30ea8f17642db5ef9(
|
|
11389
11476
|
*,
|
|
11390
11477
|
cost: builtins.str,
|
|
@@ -11506,6 +11593,7 @@ def _typecheckingstub__8a51a418ba5b606bdfc45dc50c3172e280a12e078a7392f3258d5d329
|
|
|
11506
11593
|
script_id: typing.Optional[builtins.str] = None,
|
|
11507
11594
|
server_launch_parameters: typing.Optional[builtins.str] = None,
|
|
11508
11595
|
server_launch_path: typing.Optional[builtins.str] = None,
|
|
11596
|
+
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
11509
11597
|
) -> None:
|
|
11510
11598
|
"""Type checking stubs"""
|
|
11511
11599
|
pass
|
|
@@ -824,8 +824,8 @@ class CfnStreamGroup(
|
|
|
824
824
|
) -> None:
|
|
825
825
|
'''Represents the default Amazon GameLift Streams application that a stream group hosts.
|
|
826
826
|
|
|
827
|
-
:param arn: An `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html>`_ that uniquely identifies the application resource.
|
|
828
|
-
:param id: An ID that uniquely identifies the application resource.
|
|
827
|
+
:param arn: An `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html>`_ that uniquely identifies the application resource. Example ARN: ``arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`` .
|
|
828
|
+
:param id: An ID that uniquely identifies the application resource. Example ID: ``a-9ZY8X7Wv6`` .
|
|
829
829
|
|
|
830
830
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-defaultapplication.html
|
|
831
831
|
:exampleMetadata: fixture=_generated
|
|
@@ -853,7 +853,7 @@ class CfnStreamGroup(
|
|
|
853
853
|
|
|
854
854
|
@builtins.property
|
|
855
855
|
def arn(self) -> typing.Optional[builtins.str]:
|
|
856
|
-
'''An `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html>`_ that uniquely identifies the application resource.
|
|
856
|
+
'''An `Amazon Resource Name (ARN) <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference-arns.html>`_ that uniquely identifies the application resource. Example ARN: ``arn:aws:gameliftstreams:us-west-2:111122223333:application/a-9ZY8X7Wv6`` .
|
|
857
857
|
|
|
858
858
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-defaultapplication.html#cfn-gameliftstreams-streamgroup-defaultapplication-arn
|
|
859
859
|
'''
|
|
@@ -864,7 +864,7 @@ class CfnStreamGroup(
|
|
|
864
864
|
def id(self) -> typing.Optional[builtins.str]:
|
|
865
865
|
'''An ID that uniquely identifies the application resource.
|
|
866
866
|
|
|
867
|
-
|
|
867
|
+
Example ID: ``a-9ZY8X7Wv6`` .
|
|
868
868
|
|
|
869
869
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-defaultapplication.html#cfn-gameliftstreams-streamgroup-defaultapplication-id
|
|
870
870
|
'''
|
|
@@ -903,7 +903,7 @@ class CfnStreamGroup(
|
|
|
903
903
|
|
|
904
904
|
When configuring a location for the first time, you must specify a numeric value for at least one of the two capacity types.
|
|
905
905
|
|
|
906
|
-
:param location_name: A location's name. For example, ``us-east-1`` . For a complete list of locations that Amazon GameLift Streams supports, refer to `Regions and
|
|
906
|
+
:param location_name: A location's name. For example, ``us-east-1`` . For a complete list of locations that Amazon GameLift Streams supports, refer to `Regions, quotas, and limitations <https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html>`_ in the *Amazon GameLift Streams Developer Guide* .
|
|
907
907
|
:param always_on_capacity: The streaming capacity that is allocated and ready to handle stream requests without delay. You pay for this capacity whether it's in use or not. Best for quickest time from streaming request to streaming session.
|
|
908
908
|
:param on_demand_capacity: The streaming capacity that Amazon GameLift Streams can allocate in response to stream requests, and then de-allocate when the session has terminated. This offers a cost control measure at the expense of a greater startup time (typically under 5 minutes).
|
|
909
909
|
|
|
@@ -941,7 +941,7 @@ class CfnStreamGroup(
|
|
|
941
941
|
def location_name(self) -> builtins.str:
|
|
942
942
|
'''A location's name.
|
|
943
943
|
|
|
944
|
-
For example, ``us-east-1`` . For a complete list of locations that Amazon GameLift Streams supports, refer to `Regions and
|
|
944
|
+
For example, ``us-east-1`` . For a complete list of locations that Amazon GameLift Streams supports, refer to `Regions, quotas, and limitations <https://docs.aws.amazon.com/gameliftstreams/latest/developerguide/regions-quotas.html>`_ in the *Amazon GameLift Streams Developer Guide* .
|
|
945
945
|
|
|
946
946
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gameliftstreams-streamgroup-locationconfiguration.html#cfn-gameliftstreams-streamgroup-locationconfiguration-locationname
|
|
947
947
|
'''
|
|
@@ -1746,12 +1746,6 @@ class NodejsFunction(
|
|
|
1746
1746
|
|
|
1747
1747
|
jsii.create(self.__class__, self, [scope, id, props])
|
|
1748
1748
|
|
|
1749
|
-
@jsii.python.classproperty
|
|
1750
|
-
@jsii.member(jsii_name="PROPERTY_INJECTION_ID")
|
|
1751
|
-
def PROPERTY_INJECTION_ID(cls) -> builtins.str:
|
|
1752
|
-
'''Uniquely identifies this class.'''
|
|
1753
|
-
return typing.cast(builtins.str, jsii.sget(cls, "PROPERTY_INJECTION_ID"))
|
|
1754
|
-
|
|
1755
1749
|
|
|
1756
1750
|
@jsii.data_type(
|
|
1757
1751
|
jsii_type="aws-cdk-lib.aws_lambda_nodejs.NodejsFunctionProps",
|