mgn / Client / update_launch_configuration_template

update_launch_configuration_template

mgn.Client.update_launch_configuration_template(**kwargs)

Updates an existing Launch Configuration Template by ID.

See also: AWS API Documentation

Request Syntax

response = client.update_launch_configuration_template(
    associatePublicIpAddress=True|False,
    bootMode='LEGACY_BIOS'|'UEFI',
    copyPrivateIp=True|False,
    copyTags=True|False,
    enableMapAutoTagging=True|False,
    largeVolumeConf={
        'iops': 123,
        'throughput': 123,
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
    },
    launchConfigurationTemplateID='string',
    launchDisposition='STOPPED'|'STARTED',
    licensing={
        'osByol': True|False
    },
    mapAutoTaggingMpeID='string',
    postLaunchActions={
        'cloudWatchLogGroupName': 'string',
        'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
        's3LogBucket': 'string',
        's3OutputKeyPrefix': 'string',
        'ssmDocuments': [
            {
                'actionName': 'string',
                'externalParameters': {
                    'string': {
                        'dynamicPath': 'string'
                    }
                },
                'mustSucceedForCutover': True|False,
                'parameters': {
                    'string': [
                        {
                            'parameterName': 'string',
                            'parameterType': 'STRING'
                        },
                    ]
                },
                'ssmDocumentName': 'string',
                'timeoutSeconds': 123
            },
        ]
    },
    smallVolumeConf={
        'iops': 123,
        'throughput': 123,
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
    },
    smallVolumeMaxSize=123,
    targetInstanceTypeRightSizingMethod='NONE'|'BASIC'
)

Parameters:

• associatePublicIpAddress (boolean) – Associate public Ip address.

• bootMode (string) – Launch configuration template boot mode.

• copyPrivateIp (boolean) – Copy private Ip.

• copyTags (boolean) – Copy tags.

• enableMapAutoTagging (boolean) – Enable map auto tagging.

• largeVolumeConf (dict) –

  Large volume config.

  • iops (integer) –

    Launch template disk iops configuration.

  • throughput (integer) –

    Launch template disk throughput configuration.

  • volumeType (string) –

    Launch template disk volume type configuration.

• launchConfigurationTemplateID (string) –

  [REQUIRED]

  Launch Configuration Template ID.

• launchDisposition (string) – Launch disposition.

• licensing (dict) –

  Configure Licensing.

  • osByol (boolean) –

    Configure BYOL OS licensing.

• mapAutoTaggingMpeID (string) – Launch configuration template map auto tagging MPE ID.

• postLaunchActions (dict) –

  Post Launch Action to execute on the Test or Cutover instance.

  • cloudWatchLogGroupName (string) –

    AWS Systems Manager Command’s CloudWatch log group name.

  • deployment (string) –

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

  • s3LogBucket (string) –

    AWS Systems Manager Command’s logs S3 log bucket.

  • s3OutputKeyPrefix (string) –

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

  • ssmDocuments (list) –

    AWS Systems Manager Documents.

    • (dict) –

      AWS Systems Manager Document.

      • actionName (string) – [REQUIRED]

        User-friendly name for the AWS Systems Manager Document.

      • externalParameters (dict) –

        AWS Systems Manager Document external parameters.

        • (string) –

          • (dict) –

            AWS Systems Manager Document external parameter.

            Note

            This is a Tagged Union structure. Only one of the following top level keys can be set: dynamicPath.

            • dynamicPath (string) –

              AWS Systems Manager Document external parameters dynamic path.

      • mustSucceedForCutover (boolean) –

        If true, Cutover will not be enabled if the document has failed.

      • parameters (dict) –

        AWS Systems Manager Document parameters.

        • (string) –

          • (list) –

            • (dict) –

              AWS Systems Manager Parameter Store parameter.

              • parameterName (string) – [REQUIRED]

                AWS Systems Manager Parameter Store parameter name.

              • parameterType (string) – [REQUIRED]

                AWS Systems Manager Parameter Store parameter type.

      • ssmDocumentName (string) – [REQUIRED]

        AWS Systems Manager Document name or full ARN.

      • timeoutSeconds (integer) –

        AWS Systems Manager Document timeout seconds.

• smallVolumeConf (dict) –

  Small volume config.

  • iops (integer) –

    Launch template disk iops configuration.

  • throughput (integer) –

    Launch template disk throughput configuration.

  • volumeType (string) –

    Launch template disk volume type configuration.

• smallVolumeMaxSize (integer) – Small volume maximum size.

• targetInstanceTypeRightSizingMethod (string) – Target instance type right-sizing method.

Return type:

dict

Returns:

Response Syntax

{
    'arn': 'string',
    'associatePublicIpAddress': True|False,
    'bootMode': 'LEGACY_BIOS'|'UEFI',
    'copyPrivateIp': True|False,
    'copyTags': True|False,
    'ec2LaunchTemplateID': 'string',
    'enableMapAutoTagging': True|False,
    'largeVolumeConf': {
        'iops': 123,
        'throughput': 123,
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
    },
    'launchConfigurationTemplateID': 'string',
    'launchDisposition': 'STOPPED'|'STARTED',
    'licensing': {
        'osByol': True|False
    },
    'mapAutoTaggingMpeID': 'string',
    'postLaunchActions': {
        'cloudWatchLogGroupName': 'string',
        'deployment': 'TEST_AND_CUTOVER'|'CUTOVER_ONLY'|'TEST_ONLY',
        's3LogBucket': 'string',
        's3OutputKeyPrefix': 'string',
        'ssmDocuments': [
            {
                'actionName': 'string',
                'externalParameters': {
                    'string': {
                        'dynamicPath': 'string'
                    }
                },
                'mustSucceedForCutover': True|False,
                'parameters': {
                    'string': [
                        {
                            'parameterName': 'string',
                            'parameterType': 'STRING'
                        },
                    ]
                },
                'ssmDocumentName': 'string',
                'timeoutSeconds': 123
            },
        ]
    },
    'smallVolumeConf': {
        'iops': 123,
        'throughput': 123,
        'volumeType': 'io1'|'io2'|'gp3'|'gp2'|'st1'|'sc1'|'standard'
    },
    'smallVolumeMaxSize': 123,
    'tags': {
        'string': 'string'
    },
    'targetInstanceTypeRightSizingMethod': 'NONE'|'BASIC'
}

Response Structure

• (dict) –

  • arn (string) –

    ARN of the Launch Configuration Template.

  • associatePublicIpAddress (boolean) –

    Associate public Ip address.

  • bootMode (string) –

    Launch configuration template boot mode.

  • copyPrivateIp (boolean) –

    Copy private Ip.

  • copyTags (boolean) –

    Copy tags.

  • ec2LaunchTemplateID (string) –

    EC2 launch template ID.

  • enableMapAutoTagging (boolean) –

    Enable map auto tagging.

  • largeVolumeConf (dict) –

    Large volume config.

    • iops (integer) –

      Launch template disk iops configuration.

    • throughput (integer) –

      Launch template disk throughput configuration.

    • volumeType (string) –

      Launch template disk volume type configuration.

  • launchConfigurationTemplateID (string) –

    ID of the Launch Configuration Template.

  • launchDisposition (string) –

    Launch disposition.

  • licensing (dict) –

    Configure Licensing.

    • osByol (boolean) –

      Configure BYOL OS licensing.

  • mapAutoTaggingMpeID (string) –

    Launch configuration template map auto tagging MPE ID.

  • postLaunchActions (dict) –

    Post Launch Actions of the Launch Configuration Template.

    • cloudWatchLogGroupName (string) –

      AWS Systems Manager Command’s CloudWatch log group name.

    • deployment (string) –

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

    • s3LogBucket (string) –

      AWS Systems Manager Command’s logs S3 log bucket.

    • s3OutputKeyPrefix (string) –

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

    • ssmDocuments (list) –

      AWS Systems Manager Documents.

      • (dict) –

        AWS Systems Manager Document.

        • actionName (string) –

          User-friendly name for the AWS Systems Manager Document.

        • externalParameters (dict) –

          AWS Systems Manager Document external parameters.

          • (string) –

            • (dict) –

              AWS Systems Manager Document external parameter.

              Note

              This is a Tagged Union structure. Only one of the following top level keys will be set: dynamicPath. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

              'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
              

              • dynamicPath (string) –

                AWS Systems Manager Document external parameters dynamic path.

        • mustSucceedForCutover (boolean) –

          If true, Cutover will not be enabled if the document has failed.

        • parameters (dict) –

          AWS Systems Manager Document parameters.

          • (string) –

            • (list) –

              • (dict) –

                AWS Systems Manager Parameter Store parameter.

                • parameterName (string) –

                  AWS Systems Manager Parameter Store parameter name.

                • parameterType (string) –

                  AWS Systems Manager Parameter Store parameter type.

        • ssmDocumentName (string) –

          AWS Systems Manager Document name or full ARN.

        • timeoutSeconds (integer) –

          AWS Systems Manager Document timeout seconds.

  • smallVolumeConf (dict) –

    Small volume config.

    • iops (integer) –

      Launch template disk iops configuration.

    • throughput (integer) –

      Launch template disk throughput configuration.

    • volumeType (string) –

      Launch template disk volume type configuration.

  • smallVolumeMaxSize (integer) –

    Small volume maximum size.

  • tags (dict) –

    Tags of the Launch Configuration Template.

    • (string) –

      • (string) –

  • targetInstanceTypeRightSizingMethod (string) –

    Target instance type right-sizing method.

Exceptions

• mgn.Client.exceptions.UninitializedAccountException

• mgn.Client.exceptions.ResourceNotFoundException

• mgn.Client.exceptions.ValidationException

• mgn.Client.exceptions.AccessDeniedException