Class: AWSCDK::ImageBuilder::CfnImageRecipe::SystemsManagerAgentProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ImageBuilder::CfnImageRecipe::SystemsManagerAgentProperty

Defined in:

image_builder/cfn_image_recipe.rb

Overview

Contains settings for the Systems Manager agent on your build instance.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-systemsmanageragent.html

Instance Attribute Summary

• #uninstall_after_build ⇒ Boolean, ... readonly

  Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(uninstall_after_build: nil) ⇒ SystemsManagerAgentProperty constructor

  A new instance of SystemsManagerAgentProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(uninstall_after_build: nil) ⇒ SystemsManagerAgentProperty

Returns a new instance of SystemsManagerAgentProperty.

Parameters:

• uninstall_after_build (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

  Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI.

# File 'image_builder/cfn_image_recipe.rb', line 1066

def initialize(uninstall_after_build: nil)
  @uninstall_after_build = uninstall_after_build
  Jsii::Type.check_type(@uninstall_after_build, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "uninstallAfterBuild") unless @uninstall_after_build.nil?
end

Instance Attribute Details

#uninstall_after_build ⇒ Boolean, ... (readonly)

Controls whether the Systems Manager agent is removed from your final build image, prior to creating the new AMI.

If this is set to true, then the agent is removed from the final image. If it's set to false, then the agent is left in, so that it is included in the new AMI. default value is false.

The default behavior of uninstallAfterBuild is to remove the SSM Agent if it was installed by EC2 Image Builder

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-imagerecipe-systemsmanageragent.html#cfn-imagebuilder-imagerecipe-systemsmanageragent-uninstallafterbuild

# File 'image_builder/cfn_image_recipe.rb', line 1079

def uninstall_after_build
  @uninstall_after_build
end

Class Method Details

.jsii_properties ⇒ Object

# File 'image_builder/cfn_image_recipe.rb', line 1081

def self.jsii_properties
  {
    :uninstall_after_build => "uninstallAfterBuild",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'image_builder/cfn_image_recipe.rb', line 1087

def to_jsii
  result = {}
  result.merge!({
    "uninstallAfterBuild" => @uninstall_after_build,
  })
  result.compact
end