Class: AWSCDK::ImageBuilder::CfnDistributionConfiguration::SSMParameterConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::ImageBuilder::CfnDistributionConfiguration::SSMParameterConfigurationProperty

Defined in:

image_builder/cfn_distribution_configuration.rb

Overview

Configuration for a single Parameter in the AWS Systems Manager (SSM) Parameter Store in a given Region.

See Also:

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

Instance Attribute Summary

• #ami_account_id ⇒ String^? readonly

  Specify the account that will own the Parameter in a given Region.

• #data_type ⇒ String^? readonly

  The data type specifies what type of value the Parameter contains.

• #parameter_name ⇒ String readonly

  This is the name of the Parameter in the target Region or account.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(parameter_name:, ami_account_id: nil, data_type: nil) ⇒ SSMParameterConfigurationProperty constructor

  A new instance of SSMParameterConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(parameter_name:, ami_account_id: nil, data_type: nil) ⇒ SSMParameterConfigurationProperty

Returns a new instance of SSMParameterConfigurationProperty.

Parameters:

• parameter_name (String) —

  This is the name of the Parameter in the target Region or account.

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

  Specify the account that will own the Parameter in a given Region.

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

  The data type specifies what type of value the Parameter contains.

# File 'image_builder/cfn_distribution_configuration.rb', line 1100

def initialize(parameter_name:, ami_account_id: nil, data_type: nil)
  @parameter_name = parameter_name
  Jsii::Type.check_type(@parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterName")
  @ami_account_id = ami_account_id
  Jsii::Type.check_type(@ami_account_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "amiAccountId") unless @ami_account_id.nil?
  @data_type = data_type
  Jsii::Type.check_type(@data_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataType") unless @data_type.nil?
end

Instance Attribute Details

#ami_account_id ⇒ String^? (readonly)

Specify the account that will own the Parameter in a given Region.

During distribution, this account must be specified in distribution settings as a target account for the Region.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-amiaccountid

# File 'image_builder/cfn_distribution_configuration.rb', line 1122

def ami_account_id
  @ami_account_id
end

#data_type ⇒ String^? (readonly)

The data type specifies what type of value the Parameter contains.

We recommend that you use data type aws:ec2:image .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-datatype

# File 'image_builder/cfn_distribution_configuration.rb', line 1129

def data_type
  @data_type
end

#parameter_name ⇒ String (readonly)

This is the name of the Parameter in the target Region or account.

The image distribution creates the Parameter if it doesn't already exist. Otherwise, it updates the parameter.

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-imagebuilder-distributionconfiguration-ssmparameterconfiguration.html#cfn-imagebuilder-distributionconfiguration-ssmparameterconfiguration-parametername

# File 'image_builder/cfn_distribution_configuration.rb', line 1115

def parameter_name
  @parameter_name
end

Class Method Details

.jsii_properties ⇒ Object

# File 'image_builder/cfn_distribution_configuration.rb', line 1131

def self.jsii_properties
  {
    :parameter_name => "parameterName",
    :ami_account_id => "amiAccountId",
    :data_type => "dataType",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'image_builder/cfn_distribution_configuration.rb', line 1139

def to_jsii
  result = {}
  result.merge!({
    "parameterName" => @parameter_name,
    "amiAccountId" => @ami_account_id,
    "dataType" => @data_type,
  })
  result.compact
end