CfnLaunchConfigurationTemplatePropsMixin

class aws_cdk.cfn_property_mixins.aws_mgn.CfnLaunchConfigurationTemplatePropsMixin(props, *, strategy=None)

Bases: Mixin

Account level Launch Configuration Template for AWS Application Migration Service.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-mgn-launchconfigurationtemplate.html

CloudformationResource:

AWS::MGN::LaunchConfigurationTemplate

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_mgn as mgn
import aws_cdk as cdk

# merge_strategy: cdk.IMergeStrategy

cfn_launch_configuration_template_props_mixin = mgn.CfnLaunchConfigurationTemplatePropsMixin(mgn.CfnLaunchConfigurationTemplateMixinProps(
    associate_public_ip_address=False,
    boot_mode="bootMode",
    copy_private_ip=False,
    copy_tags=False,
    enable_map_auto_tagging=False,
    enable_parameters_encryption=False,
    large_volume_conf=mgn.CfnLaunchConfigurationTemplatePropsMixin.LaunchTemplateDiskConfProperty(
        iops=123,
        throughput=123,
        volume_type="volumeType"
    ),
    launch_disposition="launchDisposition",
    licensing=mgn.CfnLaunchConfigurationTemplatePropsMixin.LicensingProperty(
        os_byol=False
    ),
    map_auto_tagging_mpe_id="mapAutoTaggingMpeId",
    parameters_encryption_key="parametersEncryptionKey",
    post_launch_actions=mgn.CfnLaunchConfigurationTemplatePropsMixin.PostLaunchActionsProperty(
        cloud_watch_log_group_name="cloudWatchLogGroupName",
        deployment="deployment",
        s3_log_bucket="s3LogBucket",
        s3_output_key_prefix="s3OutputKeyPrefix",
        ssm_documents=[mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmDocumentProperty(
            action_name="actionName",
            external_parameters={
                "external_parameters_key": mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmExternalParameterProperty(
                    dynamic_path="dynamicPath"
                )
            },
            must_succeed_for_cutover=False,
            parameters={
                "parameters_key": [mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmParameterStoreParameterProperty(
                    parameter_name="parameterName",
                    parameter_type="parameterType"
                )]
            },
            ssm_document_name="ssmDocumentName",
            timeout_seconds=123
        )]
    ),
    small_volume_conf=mgn.CfnLaunchConfigurationTemplatePropsMixin.LaunchTemplateDiskConfProperty(
        iops=123,
        throughput=123,
        volume_type="volumeType"
    ),
    small_volume_max_size=123,
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )],
    target_instance_type_right_sizing_method="targetInstanceTypeRightSizingMethod"
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::MGN::LaunchConfigurationTemplate.

Parameters:

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 = ['associatePublicIpAddress', 'bootMode', 'copyPrivateIp', 'copyTags', 'enableMapAutoTagging', 'enableParametersEncryption', 'largeVolumeConf', 'launchDisposition', 'licensing', 'mapAutoTaggingMpeId', 'parametersEncryptionKey', 'postLaunchActions', 'smallVolumeConf', 'smallVolumeMaxSize', 'tags', 'targetInstanceTypeRightSizingMethod']

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.

LaunchTemplateDiskConfProperty

class CfnLaunchConfigurationTemplatePropsMixin.LaunchTemplateDiskConfProperty(*, iops=None, throughput=None, volume_type=None)

Bases: object

Launch template disk configuration.

Parameters:
  • iops (Union[int, float, None]) – Launch template disk IOPS configuration.

  • throughput (Union[int, float, None]) – Launch template disk throughput configuration, in MiB/s.

  • volume_type (Optional[str]) – Launch template disk volume type configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-launchtemplatediskconf.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_mgn as mgn

launch_template_disk_conf_property = mgn.CfnLaunchConfigurationTemplatePropsMixin.LaunchTemplateDiskConfProperty(
    iops=123,
    throughput=123,
    volume_type="volumeType"
)

Attributes

iops

Launch template disk IOPS configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-launchtemplatediskconf.html#cfn-mgn-launchconfigurationtemplate-launchtemplatediskconf-iops

throughput

Launch template disk throughput configuration, in MiB/s.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-launchtemplatediskconf.html#cfn-mgn-launchconfigurationtemplate-launchtemplatediskconf-throughput

volume_type

Launch template disk volume type configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-launchtemplatediskconf.html#cfn-mgn-launchconfigurationtemplate-launchtemplatediskconf-volumetype

LicensingProperty

class CfnLaunchConfigurationTemplatePropsMixin.LicensingProperty(*, os_byol=None)

Bases: object

Configuration of a machine’s license.

Parameters:

os_byol (Union[bool, IResolvable, None]) – Whether to configure BYOL OS licensing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-licensing.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_mgn as mgn

licensing_property = mgn.CfnLaunchConfigurationTemplatePropsMixin.LicensingProperty(
    os_byol=False
)

Attributes

os_byol

Whether to configure BYOL OS licensing.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-licensing.html#cfn-mgn-launchconfigurationtemplate-licensing-osbyol

PostLaunchActionsProperty

class CfnLaunchConfigurationTemplatePropsMixin.PostLaunchActionsProperty(*, cloud_watch_log_group_name=None, deployment=None, s3_log_bucket=None, s3_output_key_prefix=None, ssm_documents=None)

Bases: object

Post launch actions to execute on the Test or Cutover instance.

Parameters:
  • cloud_watch_log_group_name (Optional[str]) – AWS Systems Manager Command’s CloudWatch log group name.

  • deployment (Optional[str]) – Deployment type in which AWS Systems Manager Documents will be executed.

  • s3_log_bucket (Optional[str]) – AWS Systems Manager Command’s logs S3 log bucket.

  • s3_output_key_prefix (Optional[str]) – AWS Systems Manager Command’s logs S3 output key prefix.

  • ssm_documents (Union[IResolvable, Sequence[Union[IResolvable, SsmDocumentProperty, Dict[str, Any]]], None]) – AWS Systems Manager Documents to execute, in order.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-postlaunchactions.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_mgn as mgn

post_launch_actions_property = mgn.CfnLaunchConfigurationTemplatePropsMixin.PostLaunchActionsProperty(
    cloud_watch_log_group_name="cloudWatchLogGroupName",
    deployment="deployment",
    s3_log_bucket="s3LogBucket",
    s3_output_key_prefix="s3OutputKeyPrefix",
    ssm_documents=[mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmDocumentProperty(
        action_name="actionName",
        external_parameters={
            "external_parameters_key": mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmExternalParameterProperty(
                dynamic_path="dynamicPath"
            )
        },
        must_succeed_for_cutover=False,
        parameters={
            "parameters_key": [mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmParameterStoreParameterProperty(
                parameter_name="parameterName",
                parameter_type="parameterType"
            )]
        },
        ssm_document_name="ssmDocumentName",
        timeout_seconds=123
    )]
)

Attributes

cloud_watch_log_group_name

AWS Systems Manager Command’s CloudWatch log group name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-postlaunchactions.html#cfn-mgn-launchconfigurationtemplate-postlaunchactions-cloudwatchloggroupname

deployment

Deployment type in which AWS Systems Manager Documents will be executed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-postlaunchactions.html#cfn-mgn-launchconfigurationtemplate-postlaunchactions-deployment

s3_log_bucket

AWS Systems Manager Command’s logs S3 log bucket.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-postlaunchactions.html#cfn-mgn-launchconfigurationtemplate-postlaunchactions-s3logbucket

s3_output_key_prefix

AWS Systems Manager Command’s logs S3 output key prefix.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-postlaunchactions.html#cfn-mgn-launchconfigurationtemplate-postlaunchactions-s3outputkeyprefix

ssm_documents

AWS Systems Manager Documents to execute, in order.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-postlaunchactions.html#cfn-mgn-launchconfigurationtemplate-postlaunchactions-ssmdocuments

SsmDocumentProperty

class CfnLaunchConfigurationTemplatePropsMixin.SsmDocumentProperty(*, action_name=None, external_parameters=None, must_succeed_for_cutover=None, parameters=None, ssm_document_name=None, timeout_seconds=None)

Bases: object

An AWS Systems Manager Document to execute as a post launch action.

Parameters:
  • action_name (Optional[str]) – User-friendly name for the AWS Systems Manager Document.

  • external_parameters (Union[IResolvable, Mapping[str, Union[IResolvable, SsmExternalParameterProperty, Dict[str, Any]]], None]) – AWS Systems Manager Document external parameters.

  • must_succeed_for_cutover (Union[bool, IResolvable, None]) – Whether Cutover is blocked when the document has failed.

  • parameters (Union[IResolvable, Mapping[str, Union[IResolvable, Sequence[Union[IResolvable, SsmParameterStoreParameterProperty, Dict[str, Any]]]]], None]) – AWS Systems Manager Document parameters, each resolved from AWS Systems Manager Parameter Store.

  • ssm_document_name (Optional[str]) – AWS Systems Manager Document name or full ARN.

  • timeout_seconds (Union[int, float, None]) – AWS Systems Manager Document timeout, in seconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.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_mgn as mgn

ssm_document_property = mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmDocumentProperty(
    action_name="actionName",
    external_parameters={
        "external_parameters_key": mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmExternalParameterProperty(
            dynamic_path="dynamicPath"
        )
    },
    must_succeed_for_cutover=False,
    parameters={
        "parameters_key": [mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmParameterStoreParameterProperty(
            parameter_name="parameterName",
            parameter_type="parameterType"
        )]
    },
    ssm_document_name="ssmDocumentName",
    timeout_seconds=123
)

Attributes

action_name

User-friendly name for the AWS Systems Manager Document.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-actionname

external_parameters

AWS Systems Manager Document external parameters.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-externalparameters

must_succeed_for_cutover

Whether Cutover is blocked when the document has failed.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-mustsucceedforcutover

parameters

AWS Systems Manager Document parameters, each resolved from AWS Systems Manager Parameter Store.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-parameters

ssm_document_name

AWS Systems Manager Document name or full ARN.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-ssmdocumentname

timeout_seconds

AWS Systems Manager Document timeout, in seconds.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmdocument.html#cfn-mgn-launchconfigurationtemplate-ssmdocument-timeoutseconds

SsmExternalParameterProperty

class CfnLaunchConfigurationTemplatePropsMixin.SsmExternalParameterProperty(*, dynamic_path=None)

Bases: object

An AWS Systems Manager Document external parameter.

Parameters:

dynamic_path (Optional[str]) – AWS Systems Manager Document external parameter dynamic path.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmexternalparameter.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_mgn as mgn

ssm_external_parameter_property = mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmExternalParameterProperty(
    dynamic_path="dynamicPath"
)

Attributes

dynamic_path

AWS Systems Manager Document external parameter dynamic path.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmexternalparameter.html#cfn-mgn-launchconfigurationtemplate-ssmexternalparameter-dynamicpath

SsmParameterStoreParameterProperty

class CfnLaunchConfigurationTemplatePropsMixin.SsmParameterStoreParameterProperty(*, parameter_name=None, parameter_type=None)

Bases: object

An AWS Systems Manager Parameter Store parameter.

Parameters:
  • parameter_name (Optional[str]) – AWS Systems Manager Parameter Store parameter name.

  • parameter_type (Optional[str]) – AWS Systems Manager Parameter Store parameter type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmparameterstoreparameter.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_mgn as mgn

ssm_parameter_store_parameter_property = mgn.CfnLaunchConfigurationTemplatePropsMixin.SsmParameterStoreParameterProperty(
    parameter_name="parameterName",
    parameter_type="parameterType"
)

Attributes

parameter_name

AWS Systems Manager Parameter Store parameter name.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmparameterstoreparameter.html#cfn-mgn-launchconfigurationtemplate-ssmparameterstoreparameter-parametername

parameter_type

AWS Systems Manager Parameter Store parameter type.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-mgn-launchconfigurationtemplate-ssmparameterstoreparameter.html#cfn-mgn-launchconfigurationtemplate-ssmparameterstoreparameter-parametertype