Class: AWSCDK::ImageBuilder::CfnImage::ImagePipelineExecutionSettingsProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ImageBuilder::CfnImage::ImagePipelineExecutionSettingsProperty

Defined in:

image_builder/cfn_image.rb

Overview

Contains settings for starting an image pipeline execution.

See Also:

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

Instance Attribute Summary

• #deployment_id ⇒ String^? readonly

  The deployment identifier of the pipeline, utilized to initiate new image pipeline executions.

• #on_update ⇒ Boolean, ... readonly

  Defines whether the pipeline should be executed upon pipeline updates.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(deployment_id: nil, on_update: nil) ⇒ ImagePipelineExecutionSettingsProperty constructor

  A new instance of ImagePipelineExecutionSettingsProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(deployment_id: nil, on_update: nil) ⇒ ImagePipelineExecutionSettingsProperty

Returns a new instance of ImagePipelineExecutionSettingsProperty.

Parameters:

• deployment_id (String, nil) (defaults to: nil) —

  The deployment identifier of the pipeline, utilized to initiate new image pipeline executions.

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

  Defines whether the pipeline should be executed upon pipeline updates.

# File 'image_builder/cfn_image.rb', line 869

def initialize(deployment_id: nil, on_update: nil)
  @deployment_id = deployment_id
  Jsii::Type.check_type(@deployment_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "deploymentId") unless @deployment_id.nil?
  @on_update = on_update
  Jsii::Type.check_type(@on_update, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "onUpdate") unless @on_update.nil?
end

Instance Attribute Details

#deployment_id ⇒ String^? (readonly)

The deployment identifier of the pipeline, utilized to initiate new image pipeline executions.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html#cfn-imagebuilder-image-imagepipelineexecutionsettings-deploymentid

# File 'image_builder/cfn_image.rb', line 880

def deployment_id
  @deployment_id
end

#on_update ⇒ Boolean, ... (readonly)

Defines whether the pipeline should be executed upon pipeline updates.

False by default.

Returns:

• (Boolean, AWSCDK::IResolvable, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-image-imagepipelineexecutionsettings.html#cfn-imagebuilder-image-imagepipelineexecutionsettings-onupdate

# File 'image_builder/cfn_image.rb', line 887

def on_update
  @on_update
end

Class Method Details

.jsii_properties ⇒ Object

# File 'image_builder/cfn_image.rb', line 889

def self.jsii_properties
  {
    :deployment_id => "deploymentId",
    :on_update => "onUpdate",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'image_builder/cfn_image.rb', line 896

def to_jsii
  result = {}
  result.merge!({
    "deploymentId" => @deployment_id,
    "onUpdate" => @on_update,
  })
  result.compact
end