CfnDaemonPropsMixin

class aws_cdk.cfn_property_mixins.aws_ecs.CfnDaemonPropsMixin(props, *, strategy=None)

Bases: Mixin

Information about a daemon resource.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-daemon.html
CloudformationResource:: AWS::ECS::Daemon
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_ecs as ecs
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_daemon_props_mixin = ecs.CfnDaemonPropsMixin(ecs.CfnDaemonMixinProps(
    capacity_provider_arns=["capacityProviderArns"],
    cluster_arn="clusterArn",
    daemon_name="daemonName",
    daemon_task_definition_arn="daemonTaskDefinitionArn",
    deployment_configuration=ecs.CfnDaemonPropsMixin.DaemonDeploymentConfigurationProperty(
        alarms=ecs.CfnDaemonPropsMixin.DaemonAlarmConfigurationProperty(
            alarm_names=["alarmNames"],
            enable=False
        ),
        bake_time_in_minutes=123,
        drain_percent=123
    ),
    enable_ecs_managed_tags=False,
    enable_execute_command=False,
    propagate_tags="propagateTags",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::ECS::Daemon.

Parameters:

props (Union[CfnDaemonMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['capacityProviderArns', 'clusterArn', 'daemonName', 'daemonTaskDefinitionArn', 'deploymentConfiguration', 'enableEcsManagedTags', 'enableExecuteCommand', 'propagateTags', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

DaemonAlarmConfigurationProperty

class CfnDaemonPropsMixin.DaemonAlarmConfigurationProperty(*, alarm_names=None, enable=None)

Bases: object

The CloudWatch alarm configuration for a daemon.

When enabled, CloudWatch alarms determine whether a daemon deployment has failed.

Parameters:

alarm_names (Optional[Sequence[str]]) – The CloudWatch alarm names to monitor during a daemon deployment.
enable (Union[bool, IResolvable, None]) – Determines whether to use the CloudWatch alarm option in the daemon deployment process. The default value is false.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemon-daemonalarmconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_ecs as ecs

daemon_alarm_configuration_property = ecs.CfnDaemonPropsMixin.DaemonAlarmConfigurationProperty(
    alarm_names=["alarmNames"],
    enable=False
)

Attributes

alarm_names

The CloudWatch alarm names to monitor during a daemon deployment.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemon-daemonalarmconfiguration.html#cfn-ecs-daemon-daemonalarmconfiguration-alarmnames

enable

Determines whether to use the CloudWatch alarm option in the daemon deployment process.

The default value is false.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemon-daemonalarmconfiguration.html#cfn-ecs-daemon-daemonalarmconfiguration-enable

DaemonDeploymentConfigurationProperty

class CfnDaemonPropsMixin.DaemonDeploymentConfigurationProperty(*, alarms=None, bake_time_in_minutes=None, drain_percent=None)

Bases: object

Optional deployment parameters that control how a daemon rolls out updates across container instances.

Parameters:

alarms (Union[IResolvable, DaemonAlarmConfigurationProperty, Dict[str, Any], None]) – The CloudWatch alarm configuration for a daemon. When enabled, CloudWatch alarms determine whether a daemon deployment has failed.
bake_time_in_minutes (Union[int, float, None]) – The amount of time (in minutes) to wait after a successful deployment step before proceeding. This allows time to monitor for issues before continuing. The default value is 0.
drain_percent (Union[int, float, None]) – The percentage of container instances to drain simultaneously during a daemon deployment. Valid values are between 0.0 and 100.0.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemon-daemondeploymentconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.cfn_property_mixins import aws_ecs as ecs

daemon_deployment_configuration_property = ecs.CfnDaemonPropsMixin.DaemonDeploymentConfigurationProperty(
    alarms=ecs.CfnDaemonPropsMixin.DaemonAlarmConfigurationProperty(
        alarm_names=["alarmNames"],
        enable=False
    ),
    bake_time_in_minutes=123,
    drain_percent=123
)

Attributes

alarms

The CloudWatch alarm configuration for a daemon.

When enabled, CloudWatch alarms determine whether a daemon deployment has failed.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemon-daemondeploymentconfiguration.html#cfn-ecs-daemon-daemondeploymentconfiguration-alarms

bake_time_in_minutes

The amount of time (in minutes) to wait after a successful deployment step before proceeding.

This allows time to monitor for issues before continuing. The default value is 0.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemon-daemondeploymentconfiguration.html#cfn-ecs-daemon-daemondeploymentconfiguration-baketimeinminutes

drain_percent

The percentage of container instances to drain simultaneously during a daemon deployment.

Valid values are between 0.0 and 100.0.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ecs-daemon-daemondeploymentconfiguration.html#cfn-ecs-daemon-daemondeploymentconfiguration-drainpercent