aws-cdk-lib 2.154.0__py3-none-any.whl → 2.155.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/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.154.0.jsii.tgz → aws-cdk-lib@2.155.0.jsii.tgz} +0 -0
- aws_cdk/assertions/__init__.py +17 -17
- aws_cdk/aws_apigatewayv2/__init__.py +13 -14
- aws_cdk/aws_bedrock/__init__.py +2672 -306
- aws_cdk/aws_cloudfront/__init__.py +20 -5
- aws_cdk/aws_codebuild/__init__.py +384 -4
- aws_cdk/aws_ec2/__init__.py +246 -47
- aws_cdk/aws_ecs/__init__.py +5 -3
- aws_cdk/aws_eks/__init__.py +34 -4
- aws_cdk/aws_gamelift/__init__.py +52 -40
- aws_cdk/aws_glue/__init__.py +55 -4
- aws_cdk/aws_imagebuilder/__init__.py +6 -6
- aws_cdk/aws_ivs/__init__.py +460 -2
- aws_cdk/aws_kms/__init__.py +36 -0
- aws_cdk/aws_lambda/__init__.py +38 -23
- aws_cdk/aws_lambda_event_sources/__init__.py +27 -0
- aws_cdk/aws_medialive/__init__.py +41 -0
- aws_cdk/aws_msk/__init__.py +88 -0
- aws_cdk/aws_rds/__init__.py +6 -0
- aws_cdk/aws_sagemaker/__init__.py +2 -2
- aws_cdk/aws_secretsmanager/__init__.py +3 -2
- aws_cdk/aws_ses/__init__.py +7 -7
- aws_cdk/aws_ssm/__init__.py +5 -5
- aws_cdk/aws_ssmcontacts/__init__.py +12 -0
- aws_cdk/aws_stepfunctions/__init__.py +12 -14
- aws_cdk/aws_stepfunctions_tasks/__init__.py +76 -0
- aws_cdk/aws_synthetics/__init__.py +13 -0
- aws_cdk/custom_resources/__init__.py +113 -2
- {aws_cdk_lib-2.154.0.dist-info → aws_cdk_lib-2.155.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.154.0.dist-info → aws_cdk_lib-2.155.0.dist-info}/RECORD +35 -35
- {aws_cdk_lib-2.154.0.dist-info → aws_cdk_lib-2.155.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.154.0.dist-info → aws_cdk_lib-2.155.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.154.0.dist-info → aws_cdk_lib-2.155.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.154.0.dist-info → aws_cdk_lib-2.155.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_ecs/__init__.py
CHANGED
|
@@ -12633,7 +12633,7 @@ class CfnTaskDefinition(
|
|
|
12633
12633
|
:param interactive: When this parameter is ``true`` , you can deploy containerized applications that require ``stdin`` or a ``tty`` to be allocated. This parameter maps to ``OpenStdin`` in the docker conainer create command and the ``--interactive`` option to docker run.
|
|
12634
12634
|
:param links: The ``links`` parameter allows containers to communicate with each other without the need for port mappings. This parameter is only supported if the network mode of a task definition is ``bridge`` . The ``name:internalName`` construct is analogous to ``name:alias`` in Docker links. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.. This parameter maps to ``Links`` in the docker conainer create command and the ``--link`` option to docker run. .. epigraph:: This parameter is not supported for Windows containers. > Containers that are collocated on a single container instance may be able to communicate with each other without requiring links or host port mappings. Network isolation is achieved on the container instance using security groups and VPC settings.
|
|
12635
12635
|
:param linux_parameters: Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information see `KernelCapabilities <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_KernelCapabilities.html>`_ . .. epigraph:: This parameter is not supported for Windows containers.
|
|
12636
|
-
:param log_configuration: The log configuration specification for the container. This parameter maps to ``LogConfig`` in the
|
|
12636
|
+
:param log_configuration: The log configuration specification for the container. This parameter maps to ``LogConfig`` in the docker Create a container command and the ``--log-driver`` option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see `Configure logging drivers <https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/>`_ in the Docker documentation. .. epigraph:: Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the `LogConfiguration <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html>`_ data type). Additional log drivers may be available in future releases of the Amazon ECS container agent. This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: ``sudo docker version --format '{{.Server.APIVersion}}'`` .. epigraph:: The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ``ECS_AVAILABLE_LOGGING_DRIVERS`` environment variable before containers placed on that instance can use these log configuration options. For more information, see `Amazon ECS Container Agent Configuration <https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-config.html>`_ in the *Amazon Elastic Container Service Developer Guide* .
|
|
12637
12637
|
:param memory: The amount (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. The total amount of memory reserved for all containers within a task must be lower than the task ``memory`` value, if one is specified. This parameter maps to ``Memory`` in the `Create a container <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/#operation/ContainerCreate>`_ section of the `Docker Remote API <https://docs.aws.amazon.com/https://docs.docker.com/engine/api/v1.35/>`_ and the ``--memory`` option to `docker run <https://docs.aws.amazon.com/https://docs.docker.com/engine/reference/run/#security-configuration>`_ . If using the Fargate launch type, this parameter is optional. If using the EC2 launch type, you must specify either a task-level memory value or a container-level memory value. If you specify both a container-level ``memory`` and ``memoryReservation`` value, ``memory`` must be greater than ``memoryReservation`` . If you specify ``memoryReservation`` , then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container, so you should not specify fewer than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container, so you should not specify fewer than 4 MiB of memory for your containers.
|
|
12638
12638
|
:param memory_reservation: The soft limit (in MiB) of memory to reserve for the container. When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the ``memory`` parameter (if applicable), or all of the available memory on the container instance, whichever comes first. This parameter maps to ``MemoryReservation`` in the the docker conainer create command and the ``--memory-reservation`` option to docker run. If a task-level memory value is not specified, you must specify a non-zero integer for one or both of ``memory`` or ``memoryReservation`` in a container definition. If you specify both, ``memory`` must be greater than ``memoryReservation`` . If you specify ``memoryReservation`` , then that value is subtracted from the available memory resources for the container instance where the container is placed. Otherwise, the value of ``memory`` is used. For example, if your container normally uses 128 MiB of memory, but occasionally bursts to 256 MiB of memory for short periods of time, you can set a ``memoryReservation`` of 128 MiB, and a ``memory`` hard limit of 300 MiB. This configuration would allow the container to only reserve 128 MiB of memory from the remaining resources on the container instance, but also allow the container to consume more memory resources when needed. The Docker 20.10.0 or later daemon reserves a minimum of 6 MiB of memory for a container. So, don't specify less than 6 MiB of memory for your containers. The Docker 19.03.13-ce or earlier daemon reserves a minimum of 4 MiB of memory for a container. So, don't specify less than 4 MiB of memory for your containers.
|
|
12639
12639
|
:param mount_points: The mount points for data volumes in your container. This parameter maps to ``Volumes`` in the the docker conainer create command and the ``--volume`` option to docker run. Windows containers can mount whole directories on the same drive as ``$env:ProgramData`` . Windows containers can't mount directories on a different drive, and mount point can't be across drives.
|
|
@@ -13277,7 +13277,7 @@ class CfnTaskDefinition(
|
|
|
13277
13277
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnTaskDefinition.LogConfigurationProperty"]]:
|
|
13278
13278
|
'''The log configuration specification for the container.
|
|
13279
13279
|
|
|
13280
|
-
This parameter maps to ``LogConfig`` in the
|
|
13280
|
+
This parameter maps to ``LogConfig`` in the docker Create a container command and the ``--log-driver`` option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container may use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see `Configure logging drivers <https://docs.aws.amazon.com/https://docs.docker.com/engine/admin/logging/overview/>`_ in the Docker documentation.
|
|
13281
13281
|
.. epigraph::
|
|
13282
13282
|
|
|
13283
13283
|
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the `LogConfiguration <https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_LogConfiguration.html>`_ data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.
|
|
@@ -14819,7 +14819,9 @@ class CfnTaskDefinition(
|
|
|
14819
14819
|
add: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
14820
14820
|
drop: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
14821
14821
|
) -> None:
|
|
14822
|
-
'''The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition
|
|
14822
|
+
'''The Linux capabilities to add or remove from the default Docker configuration for a container defined in the task definition.
|
|
14823
|
+
|
|
14824
|
+
For more detailed information about these Linux capabilities, see the `capabilities(7) <https://docs.aws.amazon.com/http://man7.org/linux/man-pages/man7/capabilities.7.html>`_ Linux manual page.
|
|
14823
14825
|
|
|
14824
14826
|
:param add: The Linux capabilities for the container that have been added to the default configuration provided by Docker. This parameter maps to ``CapAdd`` in the docker conainer create command and the ``--cap-add`` option to docker run. .. epigraph:: Tasks launched on AWS Fargate only support adding the ``SYS_PTRACE`` kernel capability. Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"``
|
|
14825
14827
|
:param drop: The Linux capabilities for the container that have been removed from the default configuration provided by Docker. This parameter maps to ``CapDrop`` in the docker conainer create command and the ``--cap-drop`` option to docker run. Valid values: ``"ALL" | "AUDIT_CONTROL" | "AUDIT_WRITE" | "BLOCK_SUSPEND" | "CHOWN" | "DAC_OVERRIDE" | "DAC_READ_SEARCH" | "FOWNER" | "FSETID" | "IPC_LOCK" | "IPC_OWNER" | "KILL" | "LEASE" | "LINUX_IMMUTABLE" | "MAC_ADMIN" | "MAC_OVERRIDE" | "MKNOD" | "NET_ADMIN" | "NET_BIND_SERVICE" | "NET_BROADCAST" | "NET_RAW" | "SETFCAP" | "SETGID" | "SETPCAP" | "SETUID" | "SYS_ADMIN" | "SYS_BOOT" | "SYS_CHROOT" | "SYS_MODULE" | "SYS_NICE" | "SYS_PACCT" | "SYS_PTRACE" | "SYS_RAWIO" | "SYS_RESOURCE" | "SYS_TIME" | "SYS_TTY_CONFIG" | "SYSLOG" | "WAKE_ALARM"``
|
aws_cdk/aws_eks/__init__.py
CHANGED
|
@@ -1862,7 +1862,9 @@ load_balancer_address = cluster.get_service_load_balancer_address("my-service")
|
|
|
1862
1862
|
eks.Addon(self, "Addon",
|
|
1863
1863
|
cluster=cluster,
|
|
1864
1864
|
addon_name="aws-guardduty-agent",
|
|
1865
|
-
addon_version="v1.6.1"
|
|
1865
|
+
addon_version="v1.6.1",
|
|
1866
|
+
# whether to preserve the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
|
|
1867
|
+
preserve_on_delete=False
|
|
1866
1868
|
)
|
|
1867
1869
|
```
|
|
1868
1870
|
|
|
@@ -2656,6 +2658,7 @@ class AddonAttributes:
|
|
|
2656
2658
|
"addon_name": "addonName",
|
|
2657
2659
|
"cluster": "cluster",
|
|
2658
2660
|
"addon_version": "addonVersion",
|
|
2661
|
+
"preserve_on_delete": "preserveOnDelete",
|
|
2659
2662
|
},
|
|
2660
2663
|
)
|
|
2661
2664
|
class AddonProps:
|
|
@@ -2665,12 +2668,14 @@ class AddonProps:
|
|
|
2665
2668
|
addon_name: builtins.str,
|
|
2666
2669
|
cluster: "ICluster",
|
|
2667
2670
|
addon_version: typing.Optional[builtins.str] = None,
|
|
2671
|
+
preserve_on_delete: typing.Optional[builtins.bool] = None,
|
|
2668
2672
|
) -> None:
|
|
2669
2673
|
'''Properties for creating an Amazon EKS Add-On.
|
|
2670
2674
|
|
|
2671
2675
|
:param addon_name: Name of the Add-On.
|
|
2672
2676
|
:param cluster: The EKS cluster the Add-On is associated with.
|
|
2673
2677
|
:param addon_version: Version of the Add-On. You can check all available versions with describe-addon-versons. For example, this lists all available versions for the ``eks-pod-identity-agent`` addon: $ aws eks describe-addon-versions --addon-name eks-pod-identity-agent --query 'addons[*].addonVersions[*].addonVersion' Default: the latest version.
|
|
2678
|
+
:param preserve_on_delete: Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it isn't removed. Default: true
|
|
2674
2679
|
|
|
2675
2680
|
:exampleMetadata: infused
|
|
2676
2681
|
|
|
@@ -2682,7 +2687,9 @@ class AddonProps:
|
|
|
2682
2687
|
eks.Addon(self, "Addon",
|
|
2683
2688
|
cluster=cluster,
|
|
2684
2689
|
addon_name="aws-guardduty-agent",
|
|
2685
|
-
addon_version="v1.6.1"
|
|
2690
|
+
addon_version="v1.6.1",
|
|
2691
|
+
# whether to preserve the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
|
|
2692
|
+
preserve_on_delete=False
|
|
2686
2693
|
)
|
|
2687
2694
|
'''
|
|
2688
2695
|
if __debug__:
|
|
@@ -2690,12 +2697,15 @@ class AddonProps:
|
|
|
2690
2697
|
check_type(argname="argument addon_name", value=addon_name, expected_type=type_hints["addon_name"])
|
|
2691
2698
|
check_type(argname="argument cluster", value=cluster, expected_type=type_hints["cluster"])
|
|
2692
2699
|
check_type(argname="argument addon_version", value=addon_version, expected_type=type_hints["addon_version"])
|
|
2700
|
+
check_type(argname="argument preserve_on_delete", value=preserve_on_delete, expected_type=type_hints["preserve_on_delete"])
|
|
2693
2701
|
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
2694
2702
|
"addon_name": addon_name,
|
|
2695
2703
|
"cluster": cluster,
|
|
2696
2704
|
}
|
|
2697
2705
|
if addon_version is not None:
|
|
2698
2706
|
self._values["addon_version"] = addon_version
|
|
2707
|
+
if preserve_on_delete is not None:
|
|
2708
|
+
self._values["preserve_on_delete"] = preserve_on_delete
|
|
2699
2709
|
|
|
2700
2710
|
@builtins.property
|
|
2701
2711
|
def addon_name(self) -> builtins.str:
|
|
@@ -2725,6 +2735,17 @@ class AddonProps:
|
|
|
2725
2735
|
result = self._values.get("addon_version")
|
|
2726
2736
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
2727
2737
|
|
|
2738
|
+
@builtins.property
|
|
2739
|
+
def preserve_on_delete(self) -> typing.Optional[builtins.bool]:
|
|
2740
|
+
'''Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
|
|
2741
|
+
|
|
2742
|
+
If an IAM account is associated with the add-on, it isn't removed.
|
|
2743
|
+
|
|
2744
|
+
:default: true
|
|
2745
|
+
'''
|
|
2746
|
+
result = self._values.get("preserve_on_delete")
|
|
2747
|
+
return typing.cast(typing.Optional[builtins.bool], result)
|
|
2748
|
+
|
|
2728
2749
|
def __eq__(self, rhs: typing.Any) -> builtins.bool:
|
|
2729
2750
|
return isinstance(rhs, self.__class__) and rhs._values == self._values
|
|
2730
2751
|
|
|
@@ -16806,7 +16827,9 @@ class Addon(
|
|
|
16806
16827
|
eks.Addon(self, "Addon",
|
|
16807
16828
|
cluster=cluster,
|
|
16808
16829
|
addon_name="aws-guardduty-agent",
|
|
16809
|
-
addon_version="v1.6.1"
|
|
16830
|
+
addon_version="v1.6.1",
|
|
16831
|
+
# whether to preserve the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on.
|
|
16832
|
+
preserve_on_delete=False
|
|
16810
16833
|
)
|
|
16811
16834
|
'''
|
|
16812
16835
|
|
|
@@ -16818,6 +16841,7 @@ class Addon(
|
|
|
16818
16841
|
addon_name: builtins.str,
|
|
16819
16842
|
cluster: ICluster,
|
|
16820
16843
|
addon_version: typing.Optional[builtins.str] = None,
|
|
16844
|
+
preserve_on_delete: typing.Optional[builtins.bool] = None,
|
|
16821
16845
|
) -> None:
|
|
16822
16846
|
'''Creates a new Amazon EKS Add-On.
|
|
16823
16847
|
|
|
@@ -16826,13 +16850,17 @@ class Addon(
|
|
|
16826
16850
|
:param addon_name: Name of the Add-On.
|
|
16827
16851
|
:param cluster: The EKS cluster the Add-On is associated with.
|
|
16828
16852
|
:param addon_version: Version of the Add-On. You can check all available versions with describe-addon-versons. For example, this lists all available versions for the ``eks-pod-identity-agent`` addon: $ aws eks describe-addon-versions --addon-name eks-pod-identity-agent --query 'addons[*].addonVersions[*].addonVersion' Default: the latest version.
|
|
16853
|
+
:param preserve_on_delete: Specifying this option preserves the add-on software on your cluster but Amazon EKS stops managing any settings for the add-on. If an IAM account is associated with the add-on, it isn't removed. Default: true
|
|
16829
16854
|
'''
|
|
16830
16855
|
if __debug__:
|
|
16831
16856
|
type_hints = typing.get_type_hints(_typecheckingstub__a8342124e215d4789acf852df764143c4809251dbcaa86f6b4a11860e46f830d)
|
|
16832
16857
|
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
16833
16858
|
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
16834
16859
|
props = AddonProps(
|
|
16835
|
-
addon_name=addon_name,
|
|
16860
|
+
addon_name=addon_name,
|
|
16861
|
+
cluster=cluster,
|
|
16862
|
+
addon_version=addon_version,
|
|
16863
|
+
preserve_on_delete=preserve_on_delete,
|
|
16836
16864
|
)
|
|
16837
16865
|
|
|
16838
16866
|
jsii.create(self.__class__, self, [scope, id, props])
|
|
@@ -20043,6 +20071,7 @@ def _typecheckingstub__febc9f6cb4243d885b1b1838be38d633e7c5fc6534eaaf731f00a2465
|
|
|
20043
20071
|
addon_name: builtins.str,
|
|
20044
20072
|
cluster: ICluster,
|
|
20045
20073
|
addon_version: typing.Optional[builtins.str] = None,
|
|
20074
|
+
preserve_on_delete: typing.Optional[builtins.bool] = None,
|
|
20046
20075
|
) -> None:
|
|
20047
20076
|
"""Type checking stubs"""
|
|
20048
20077
|
pass
|
|
@@ -21672,6 +21701,7 @@ def _typecheckingstub__a8342124e215d4789acf852df764143c4809251dbcaa86f6b4a11860e
|
|
|
21672
21701
|
addon_name: builtins.str,
|
|
21673
21702
|
cluster: ICluster,
|
|
21674
21703
|
addon_version: typing.Optional[builtins.str] = None,
|
|
21704
|
+
preserve_on_delete: typing.Optional[builtins.bool] = None,
|
|
21675
21705
|
) -> None:
|
|
21676
21706
|
"""Type checking stubs"""
|
|
21677
21707
|
pass
|
aws_cdk/aws_gamelift/__init__.py
CHANGED
|
@@ -863,7 +863,9 @@ class CfnContainerGroupDefinition(
|
|
|
863
863
|
metaclass=jsii.JSIIMeta,
|
|
864
864
|
jsii_type="aws-cdk-lib.aws_gamelift.CfnContainerGroupDefinition",
|
|
865
865
|
):
|
|
866
|
-
'''*This data type is
|
|
866
|
+
'''*This data type is currently not available.
|
|
867
|
+
|
|
868
|
+
It is under improvement as we respond to customer feedback from the Containers public preview.*
|
|
867
869
|
|
|
868
870
|
The properties that describe a container group resource. Container group definition properties can't be updated. To change a property, create a new container group definition.
|
|
869
871
|
|
|
@@ -955,8 +957,8 @@ class CfnContainerGroupDefinition(
|
|
|
955
957
|
:param container_definitions: The set of container definitions that are included in the container group.
|
|
956
958
|
:param name: A descriptive identifier for the container group definition. The name value is unique in an AWS Region.
|
|
957
959
|
:param operating_system: The platform required for all containers in the container group definition. .. epigraph:: Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the `Amazon Linux 2 FAQs <https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/>`_ . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to Amazon GameLift server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
|
|
958
|
-
:param total_cpu_limit: The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units). You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.
|
|
959
|
-
:param total_memory_limit: The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources. You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must meet the following requirements: - Equal to or greater than the sum of all container-specific soft memory limits in the group. - Equal to or greater than any container-specific hard limits in the group.
|
|
960
|
+
:param total_cpu_limit: The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units). You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.
|
|
961
|
+
:param total_memory_limit: The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources. You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must meet the following requirements: - Equal to or greater than the sum of all container-specific soft memory limits in the group. - Equal to or greater than any container-specific hard limits in the group.
|
|
960
962
|
:param scheduling_strategy: The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.
|
|
961
963
|
:param tags: An array of key-value pairs to apply to this resource.
|
|
962
964
|
'''
|
|
@@ -1170,7 +1172,9 @@ class CfnContainerGroupDefinition(
|
|
|
1170
1172
|
resolved_image_digest: typing.Optional[builtins.str] = None,
|
|
1171
1173
|
working_directory: typing.Optional[builtins.str] = None,
|
|
1172
1174
|
) -> None:
|
|
1173
|
-
'''*This data type is
|
|
1175
|
+
'''*This data type is currently not available.
|
|
1176
|
+
|
|
1177
|
+
It is under improvement as we respond to customer feedback from the Containers public preview.*
|
|
1174
1178
|
|
|
1175
1179
|
Describes a container in a container fleet, the resources available to the container, and the commands that are run when the container starts. Container properties can't be updated. To change a property, create a new container group definition. See also ``ContainerDefinitionInput`` .
|
|
1176
1180
|
|
|
@@ -1468,7 +1472,9 @@ class CfnContainerGroupDefinition(
|
|
|
1468
1472
|
condition: builtins.str,
|
|
1469
1473
|
container_name: builtins.str,
|
|
1470
1474
|
) -> None:
|
|
1471
|
-
'''*This data type is
|
|
1475
|
+
'''*This data type is currently not available.
|
|
1476
|
+
|
|
1477
|
+
It is under improvement as we respond to customer feedback from the Containers public preview.*
|
|
1472
1478
|
|
|
1473
1479
|
A container's dependency on another container in the same container group. The dependency impacts how the dependent container is able to start or shut down based the status of the other container.
|
|
1474
1480
|
|
|
@@ -1545,7 +1551,9 @@ class CfnContainerGroupDefinition(
|
|
|
1545
1551
|
)
|
|
1546
1552
|
class ContainerEnvironmentProperty:
|
|
1547
1553
|
def __init__(self, *, name: builtins.str, value: builtins.str) -> None:
|
|
1548
|
-
'''*This data type is
|
|
1554
|
+
'''*This data type is currently not available.
|
|
1555
|
+
|
|
1556
|
+
It is under improvement as we respond to customer feedback from the Containers public preview.*
|
|
1549
1557
|
|
|
1550
1558
|
An environment variable to set inside a container, in the form of a key-value pair.
|
|
1551
1559
|
|
|
@@ -1759,7 +1767,9 @@ class CfnContainerGroupDefinition(
|
|
|
1759
1767
|
protocol: builtins.str,
|
|
1760
1768
|
to_port: jsii.Number,
|
|
1761
1769
|
) -> None:
|
|
1762
|
-
'''*This data type is
|
|
1770
|
+
'''*This data type is currently not available.
|
|
1771
|
+
|
|
1772
|
+
It is under improvement as we respond to customer feedback from the Containers public preview.*
|
|
1763
1773
|
|
|
1764
1774
|
A set of one or more port numbers that can be opened on the container.
|
|
1765
1775
|
|
|
@@ -2001,8 +2011,8 @@ class CfnContainerGroupDefinitionProps:
|
|
|
2001
2011
|
:param container_definitions: The set of container definitions that are included in the container group.
|
|
2002
2012
|
:param name: A descriptive identifier for the container group definition. The name value is unique in an AWS Region.
|
|
2003
2013
|
:param operating_system: The platform required for all containers in the container group definition. .. epigraph:: Amazon Linux 2 (AL2) will reach end of support on 6/30/2025. See more details in the `Amazon Linux 2 FAQs <https://docs.aws.amazon.com/https://aws.amazon.com/amazon-linux-2/faqs/>`_ . For game servers that are hosted on AL2 and use Amazon GameLift server SDK 4.x., first update the game server build to server SDK 5.x, and then deploy to AL2023 instances. See `Migrate to Amazon GameLift server SDK version 5. <https://docs.aws.amazon.com/gamelift/latest/developerguide/reference-serversdk5-migration.html>`_
|
|
2004
|
-
:param total_cpu_limit: The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units). You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.
|
|
2005
|
-
:param total_memory_limit: The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources. You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must meet the following requirements: - Equal to or greater than the sum of all container-specific soft memory limits in the group. - Equal to or greater than any container-specific hard limits in the group.
|
|
2014
|
+
:param total_cpu_limit: The amount of CPU units on a fleet instance to allocate for the container group. All containers in the group share these resources. This property is an integer value in CPU units (1 vCPU is equal to 1024 CPU units). You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.
|
|
2015
|
+
:param total_memory_limit: The amount of memory (in MiB) on a fleet instance to allocate for the container group. All containers in the group share these resources. You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must meet the following requirements: - Equal to or greater than the sum of all container-specific soft memory limits in the group. - Equal to or greater than any container-specific hard limits in the group.
|
|
2006
2016
|
:param scheduling_strategy: The method for deploying the container group across fleet instances. A replica container group might have multiple copies on each fleet instance. A daemon container group maintains only one copy per fleet instance.
|
|
2007
2017
|
:param tags: An array of key-value pairs to apply to this resource.
|
|
2008
2018
|
|
|
@@ -2136,8 +2146,6 @@ class CfnContainerGroupDefinitionProps:
|
|
|
2136
2146
|
|
|
2137
2147
|
You can set additional limits for each ``ContainerDefinition`` in the group. If individual containers have limits, this value must be equal to or greater than the sum of all container-specific CPU limits in the group.
|
|
2138
2148
|
|
|
2139
|
-
For more details on memory allocation, see the `Container fleet design guide <https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet>`_ .
|
|
2140
|
-
|
|
2141
2149
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalcpulimit
|
|
2142
2150
|
'''
|
|
2143
2151
|
result = self._values.get("total_cpu_limit")
|
|
@@ -2155,8 +2163,6 @@ class CfnContainerGroupDefinitionProps:
|
|
|
2155
2163
|
- Equal to or greater than the sum of all container-specific soft memory limits in the group.
|
|
2156
2164
|
- Equal to or greater than any container-specific hard limits in the group.
|
|
2157
2165
|
|
|
2158
|
-
For more details on memory allocation, see the `Container fleet design guide <https://docs.aws.amazon.com/gamelift/latest/developerguide/containers-design-fleet>`_ .
|
|
2159
|
-
|
|
2160
2166
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-containergroupdefinition.html#cfn-gamelift-containergroupdefinition-totalmemorylimit
|
|
2161
2167
|
'''
|
|
2162
2168
|
result = self._values.get("total_memory_limit")
|
|
@@ -2348,18 +2354,18 @@ class CfnFleet(
|
|
|
2348
2354
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
2349
2355
|
:param name: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
|
|
2350
2356
|
:param anywhere_configuration: Amazon GameLift Anywhere configuration options.
|
|
2351
|
-
:param apply_capacity: Current resource capacity settings for managed EC2 fleets
|
|
2357
|
+
:param apply_capacity: Current resource capacity settings for managed EC2 fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region. *Returned by:* `DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ , `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ , `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
2352
2358
|
:param build_id: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a ``READY`` status. This fleet setting cannot be changed once the fleet is created.
|
|
2353
2359
|
:param certificate_configuration: Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. 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* .
|
|
2354
2360
|
: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. - ``CONTAINER`` – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ``ContainerGroupsConfiguration`` parameter. - ``ANYWHERE`` – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
|
|
2355
|
-
:param container_groups_configuration: *This data type is
|
|
2361
|
+
:param container_groups_configuration: *This data type is currently not available. It is under improvement as we respond to customer feedback from the Containers public preview.* Configuration details for a set of container groups, for use when creating a fleet with compute type ``CONTAINER`` . *Used with:* ``CreateFleet``
|
|
2356
2362
|
:param description: A description for the fleet.
|
|
2357
2363
|
: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.
|
|
2358
2364
|
: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 EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call ``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 Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges. To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
|
|
2359
2365
|
:param ec2_instance_type: The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container 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.
|
|
2360
2366
|
: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.
|
|
2361
|
-
:param instance_role_arn: A unique identifier for an IAM role with access permissions to other AWS services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, 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"
|
|
2362
|
-
: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"
|
|
2367
|
+
:param instance_role_arn: A unique identifier for an IAM role with access permissions to other AWS services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, 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".
|
|
2368
|
+
: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".
|
|
2363
2369
|
: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. 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 requires you to include your home location in the request. For a list of supported Regions and Local Zones, see `Amazon GameLift service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
2364
2370
|
: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()
|
|
2365
2371
|
: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.
|
|
@@ -2501,7 +2507,7 @@ class CfnFleet(
|
|
|
2501
2507
|
@builtins.property
|
|
2502
2508
|
@jsii.member(jsii_name="applyCapacity")
|
|
2503
2509
|
def apply_capacity(self) -> typing.Optional[builtins.str]:
|
|
2504
|
-
'''Current resource capacity settings for managed EC2 fleets
|
|
2510
|
+
'''Current resource capacity settings for managed EC2 fleets.'''
|
|
2505
2511
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "applyCapacity"))
|
|
2506
2512
|
|
|
2507
2513
|
@apply_capacity.setter
|
|
@@ -2560,7 +2566,7 @@ class CfnFleet(
|
|
|
2560
2566
|
def container_groups_configuration(
|
|
2561
2567
|
self,
|
|
2562
2568
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.ContainerGroupsConfigurationProperty"]]:
|
|
2563
|
-
'''*This data type is
|
|
2569
|
+
'''*This data type is currently not available.'''
|
|
2564
2570
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.ContainerGroupsConfigurationProperty"]], jsii.get(self, "containerGroupsConfiguration"))
|
|
2565
2571
|
|
|
2566
2572
|
@container_groups_configuration.setter
|
|
@@ -3012,7 +3018,9 @@ class CfnFleet(
|
|
|
3012
3018
|
)
|
|
3013
3019
|
class ConnectionPortRangeProperty:
|
|
3014
3020
|
def __init__(self, *, from_port: jsii.Number, to_port: jsii.Number) -> None:
|
|
3015
|
-
'''*This
|
|
3021
|
+
'''*This data type is currently not available.
|
|
3022
|
+
|
|
3023
|
+
It is under improvement as we respond to customer feedback from the Containers public preview.*
|
|
3016
3024
|
|
|
3017
3025
|
The set of port numbers to open on each instance in a container fleet. Connection ports are used by inbound traffic to connect with processes that are running in containers on the fleet.
|
|
3018
3026
|
|
|
@@ -3094,7 +3102,9 @@ class CfnFleet(
|
|
|
3094
3102
|
container_group_definition_names: typing.Sequence[builtins.str],
|
|
3095
3103
|
container_groups_per_instance: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFleet.ContainerGroupsPerInstanceProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3096
3104
|
) -> None:
|
|
3097
|
-
'''*This data type is
|
|
3105
|
+
'''*This data type is currently not available.
|
|
3106
|
+
|
|
3107
|
+
It is under improvement as we respond to customer feedback from the Containers public preview.*
|
|
3098
3108
|
|
|
3099
3109
|
Configuration details for a set of container groups, for use when creating a fleet with compute type ``CONTAINER`` .
|
|
3100
3110
|
|
|
@@ -3207,7 +3217,9 @@ class CfnFleet(
|
|
|
3207
3217
|
desired_replica_container_groups_per_instance: typing.Optional[jsii.Number] = None,
|
|
3208
3218
|
max_replica_container_groups_per_instance: typing.Optional[jsii.Number] = None,
|
|
3209
3219
|
) -> None:
|
|
3210
|
-
'''*This data type is
|
|
3220
|
+
'''*This data type is currently not available.
|
|
3221
|
+
|
|
3222
|
+
It is under improvement as we respond to customer feedback from the Containers public preview.*
|
|
3211
3223
|
|
|
3212
3224
|
Determines how many replica container groups that Amazon GameLift deploys to each instance in a container fleet.
|
|
3213
3225
|
|
|
@@ -3418,7 +3430,7 @@ class CfnFleet(
|
|
|
3418
3430
|
max_size: jsii.Number,
|
|
3419
3431
|
min_size: jsii.Number,
|
|
3420
3432
|
) -> None:
|
|
3421
|
-
'''Current resource capacity settings for managed EC2 fleets
|
|
3433
|
+
'''Current resource capacity settings for managed EC2 fleets.
|
|
3422
3434
|
|
|
3423
3435
|
For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
|
|
3424
3436
|
|
|
@@ -3513,12 +3525,10 @@ class CfnFleet(
|
|
|
3513
3525
|
location: builtins.str,
|
|
3514
3526
|
location_capacity: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnFleet.LocationCapacityProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3515
3527
|
) -> None:
|
|
3516
|
-
'''
|
|
3517
|
-
|
|
3518
|
-
A remote location where a multi-location fleet can deploy game servers for game hosting.
|
|
3528
|
+
'''A remote location where a multi-location fleet can deploy game servers for game hosting.
|
|
3519
3529
|
|
|
3520
3530
|
:param location: An AWS Region code, such as ``us-west-2`` . For a list of supported Regions and Local Zones, see `Amazon GameLift service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
3521
|
-
:param location_capacity: Current resource capacity settings for managed EC2 fleets
|
|
3531
|
+
:param location_capacity: Current resource capacity settings for managed EC2 fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region. *Returned by:* `DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ , `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ , `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
3522
3532
|
|
|
3523
3533
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-locationconfiguration.html
|
|
3524
3534
|
:exampleMetadata: fixture=_generated
|
|
@@ -3566,7 +3576,7 @@ class CfnFleet(
|
|
|
3566
3576
|
def location_capacity(
|
|
3567
3577
|
self,
|
|
3568
3578
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnFleet.LocationCapacityProperty"]]:
|
|
3569
|
-
'''Current resource capacity settings for managed EC2 fleets
|
|
3579
|
+
'''Current resource capacity settings for managed EC2 fleets.
|
|
3570
3580
|
|
|
3571
3581
|
For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
|
|
3572
3582
|
|
|
@@ -3693,7 +3703,7 @@ class CfnFleet(
|
|
|
3693
3703
|
A GameLift instance is limited to 50 processes running concurrently. To calculate the total number of processes in a runtime configuration, add the values of the ``ConcurrentExecutions`` parameter for each ServerProcess. Learn more about `Running Multiple Processes on a Fleet <https://docs.aws.amazon.com/gamelift/latest/developerguide/fleets-multiprocess.html>`_ .
|
|
3694
3704
|
|
|
3695
3705
|
:param game_session_activation_timeout_seconds: The maximum amount of time (in seconds) allowed to launch a new game session and have it report ready to host players. During this time, the game session is in status ``ACTIVATING`` . If the game session does not become active before the timeout, it is ended and the game session status is changed to ``TERMINATED`` .
|
|
3696
|
-
:param max_concurrent_game_session_activations: The number of game sessions in status ``ACTIVATING`` to allow on an instance
|
|
3706
|
+
:param max_concurrent_game_session_activations: The number of game sessions in status ``ACTIVATING`` to allow on an instance. This setting limits the instance resources that can be used for new game activations at any one time.
|
|
3697
3707
|
:param server_processes: A collection of server process configurations that identify what server processes to run on fleet computes.
|
|
3698
3708
|
|
|
3699
3709
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-runtimeconfiguration.html
|
|
@@ -3747,7 +3757,7 @@ class CfnFleet(
|
|
|
3747
3757
|
def max_concurrent_game_session_activations(
|
|
3748
3758
|
self,
|
|
3749
3759
|
) -> typing.Optional[jsii.Number]:
|
|
3750
|
-
'''The number of game sessions in status ``ACTIVATING`` to allow on an instance
|
|
3760
|
+
'''The number of game sessions in status ``ACTIVATING`` to allow on an instance.
|
|
3751
3761
|
|
|
3752
3762
|
This setting limits the instance resources that can be used for new game activations at any one time.
|
|
3753
3763
|
|
|
@@ -4075,7 +4085,7 @@ class CfnFleet(
|
|
|
4075
4085
|
|
|
4076
4086
|
Server processes run either an executable in a custom game build or a Realtime Servers script.
|
|
4077
4087
|
|
|
4078
|
-
:param concurrent_executions: The number of server processes using this configuration that run concurrently on each instance
|
|
4088
|
+
:param concurrent_executions: The number of server processes using this configuration that run concurrently on each instance.
|
|
4079
4089
|
:param launch_path: The location of a game build executable or Realtime script. Game builds and Realtime scripts are installed on instances at the root: - Windows (custom game builds only): ``C:\\game`` . Example: " ``C:\\game\\MyGame\\server.exe`` " - Linux: ``/local/game`` . Examples: " ``/local/game/MyGame/server.exe`` " or " ``/local/game/MyRealtimeScript.js`` " .. epigraph:: Amazon GameLift doesn't support the use of setup scripts that launch the game executable. For custom game builds, this parameter must indicate the executable that calls the server SDK operations ``initSDK()`` and ``ProcessReady()`` .
|
|
4080
4090
|
:param parameters: An optional list of parameters to pass to the server executable or Realtime script on launch. Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: [A-Za-z0-9_:.+/\\- =@{},?'[]"]+
|
|
4081
4091
|
|
|
@@ -4110,7 +4120,7 @@ class CfnFleet(
|
|
|
4110
4120
|
|
|
4111
4121
|
@builtins.property
|
|
4112
4122
|
def concurrent_executions(self) -> jsii.Number:
|
|
4113
|
-
'''The number of server processes using this configuration that run concurrently on each instance
|
|
4123
|
+
'''The number of server processes using this configuration that run concurrently on each instance.
|
|
4114
4124
|
|
|
4115
4125
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-gamelift-fleet-serverprocess.html#cfn-gamelift-fleet-serverprocess-concurrentexecutions
|
|
4116
4126
|
'''
|
|
@@ -4289,18 +4299,18 @@ class CfnFleetProps:
|
|
|
4289
4299
|
|
|
4290
4300
|
:param name: A descriptive label that is associated with a fleet. Fleet names do not need to be unique.
|
|
4291
4301
|
:param anywhere_configuration: Amazon GameLift Anywhere configuration options.
|
|
4292
|
-
:param apply_capacity: Current resource capacity settings for managed EC2 fleets
|
|
4302
|
+
:param apply_capacity: Current resource capacity settings for managed EC2 fleets. For multi-location fleets, location values might refer to a fleet's remote location or its home Region. *Returned by:* `DescribeFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetCapacity.html>`_ , `DescribeFleetLocationCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_DescribeFleetLocationCapacity.html>`_ , `UpdateFleetCapacity <https://docs.aws.amazon.com/gamelift/latest/apireference/API_UpdateFleetCapacity.html>`_
|
|
4293
4303
|
:param build_id: A unique identifier for a build to be deployed on the new fleet. If you are deploying the fleet with a custom game build, you must specify this property. The build must have been successfully uploaded to Amazon GameLift and be in a ``READY`` status. This fleet setting cannot be changed once the fleet is created.
|
|
4294
4304
|
:param certificate_configuration: Prompts Amazon GameLift to generate a TLS/SSL certificate for the fleet. Amazon GameLift uses the certificates to encrypt traffic between game clients and the game servers running on Amazon GameLift. 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* .
|
|
4295
4305
|
: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. - ``CONTAINER`` – Container images with your game server build and supporting software are deployed to Amazon EC2 instances for cloud hosting. With this compute type, you must specify the ``ContainerGroupsConfiguration`` parameter. - ``ANYWHERE`` – Game servers or container images with your game server and supporting software are deployed to compute resources that are provided and managed by you. With this compute type, you can also set the ``AnywhereConfiguration`` parameter.
|
|
4296
|
-
:param container_groups_configuration: *This data type is
|
|
4306
|
+
:param container_groups_configuration: *This data type is currently not available. It is under improvement as we respond to customer feedback from the Containers public preview.* Configuration details for a set of container groups, for use when creating a fleet with compute type ``CONTAINER`` . *Used with:* ``CreateFleet``
|
|
4297
4307
|
:param description: A description for the fleet.
|
|
4298
4308
|
: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.
|
|
4299
4309
|
: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 EC2 and container fleets. You can leave this parameter empty when creating the fleet, but you must call ``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 Realtime Servers fleets, Amazon GameLift automatically sets TCP and UDP ranges. To manage inbound access for a container fleet, set this parameter to the same port numbers that you set for the fleet's connection port range. During the life of the fleet, update this parameter to control which connection ports are open to inbound traffic.
|
|
4300
4310
|
:param ec2_instance_type: The Amazon GameLift-supported Amazon EC2 instance type to use with EC2 and container 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.
|
|
4301
4311
|
: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.
|
|
4302
|
-
:param instance_role_arn: A unique identifier for an IAM role with access permissions to other AWS services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, 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"
|
|
4303
|
-
: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"
|
|
4312
|
+
:param instance_role_arn: A unique identifier for an IAM role with access permissions to other AWS services. Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, 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".
|
|
4313
|
+
: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".
|
|
4304
4314
|
: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. 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 requires you to include your home location in the request. For a list of supported Regions and Local Zones, see `Amazon GameLift service locations <https://docs.aws.amazon.com/gamelift/latest/developerguide/gamelift-regions.html>`_ for managed hosting.
|
|
4305
4315
|
: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()
|
|
4306
4316
|
: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.
|
|
@@ -4531,7 +4541,7 @@ class CfnFleetProps:
|
|
|
4531
4541
|
|
|
4532
4542
|
@builtins.property
|
|
4533
4543
|
def apply_capacity(self) -> typing.Optional[builtins.str]:
|
|
4534
|
-
'''Current resource capacity settings for managed EC2 fleets
|
|
4544
|
+
'''Current resource capacity settings for managed EC2 fleets.
|
|
4535
4545
|
|
|
4536
4546
|
For multi-location fleets, location values might refer to a fleet's remote location or its home Region.
|
|
4537
4547
|
|
|
@@ -4588,7 +4598,9 @@ class CfnFleetProps:
|
|
|
4588
4598
|
def container_groups_configuration(
|
|
4589
4599
|
self,
|
|
4590
4600
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnFleet.ContainerGroupsConfigurationProperty]]:
|
|
4591
|
-
'''*This data type is
|
|
4601
|
+
'''*This data type is currently not available.
|
|
4602
|
+
|
|
4603
|
+
It is under improvement as we respond to customer feedback from the Containers public preview.*
|
|
4592
4604
|
|
|
4593
4605
|
Configuration details for a set of container groups, for use when creating a fleet with compute type ``CONTAINER`` .
|
|
4594
4606
|
|
|
@@ -4660,7 +4672,7 @@ class CfnFleetProps:
|
|
|
4660
4672
|
def instance_role_arn(self) -> typing.Optional[builtins.str]:
|
|
4661
4673
|
'''A unique identifier for an IAM role with access permissions to other AWS services.
|
|
4662
4674
|
|
|
4663
|
-
Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, 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"
|
|
4675
|
+
Any application that runs on an instance in the fleet--including install scripts, server processes, and other processes--can use these permissions to interact with AWS resources that you own or have access to. For more information about using the role with your game server builds, 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".
|
|
4664
4676
|
|
|
4665
4677
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolearn
|
|
4666
4678
|
'''
|
|
@@ -4671,7 +4683,7 @@ class CfnFleetProps:
|
|
|
4671
4683
|
def instance_role_credentials_provider(self) -> typing.Optional[builtins.str]:
|
|
4672
4684
|
'''Indicates that fleet instances maintain a shared credentials file for the IAM role defined in ``InstanceRoleArn`` .
|
|
4673
4685
|
|
|
4674
|
-
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"
|
|
4686
|
+
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".
|
|
4675
4687
|
|
|
4676
4688
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-gamelift-fleet.html#cfn-gamelift-fleet-instancerolecredentialsprovider
|
|
4677
4689
|
'''
|