Class: AWSCDK::ElasticBeanstalk::CfnEnvironment::OptionSettingProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
elastic_beanstalk/cfn_environment.rb

Overview

Use the OptionSetting property type to specify an option for an AWS Elastic Beanstalk environment when defining an AWS::ElasticBeanstalk::Environment resource in an AWS CloudFormation template.

The OptionSetting property type specifies an option for an AWS Elastic Beanstalk environment.

The OptionSettings property of the AWS::ElasticBeanstalk::Environment resource contains a list of OptionSetting property types.

For a list of possible namespaces and option values, see Option Values in the AWS Elastic Beanstalk Developer Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(namespace:, option_name:, resource_name: nil, value: nil) ⇒ OptionSettingProperty

Returns a new instance of OptionSettingProperty.

Parameters:

  • namespace (String) —

    A unique namespace that identifies the option's associated AWS resource.

  • option_name (String) —

    The name of the configuration option.

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

    A unique resource name for the option setting.

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

    The current value for the configuration option.



671
672
673
674
675
676
677
678
679
680
 
# File 'elastic_beanstalk/cfn_environment.rb', line 671

def initialize(namespace:, option_name:, resource_name: nil, value: nil)
  @namespace = namespace
  Jsii::Type.check_type(@namespace, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "namespace")
  @option_name = option_name
  Jsii::Type.check_type(@option_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "optionName")
  @resource_name = resource_name
  Jsii::Type.check_type(@resource_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "resourceName") unless @resource_name.nil?
  @value = value
  Jsii::Type.check_type(@value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "value") unless @value.nil?
end

Instance Attribute Details

#namespace ⇒ String (readonly)

A unique namespace that identifies the option's associated AWS resource.

Returns:

  • (String)

See Also:



686
687
688
 
# File 'elastic_beanstalk/cfn_environment.rb', line 686

def namespace
  @namespace
end

#option_name ⇒ String (readonly)

The name of the configuration option.

Returns:

  • (String)

See Also:



691
692
693
 
# File 'elastic_beanstalk/cfn_environment.rb', line 691

def option_name
  @option_name
end

#resource_name ⇒ String? (readonly)

A unique resource name for the option setting.

Use it for a time–based scaling configuration option.

Returns:

  • (String, nil)

See Also:



698
699
700
 
# File 'elastic_beanstalk/cfn_environment.rb', line 698

def resource_name
  @resource_name
end

#value ⇒ String? (readonly)

The current value for the configuration option.

Returns:

  • (String, nil)

See Also:



703
704
705
 
# File 'elastic_beanstalk/cfn_environment.rb', line 703

def value
  @value
end

Class Method Details

.jsii_properties ⇒ Object 



705
706
707
708
709
710
711
712
 
# File 'elastic_beanstalk/cfn_environment.rb', line 705

def self.jsii_properties
  {
    :namespace => "namespace",
    :option_name => "optionName",
    :resource_name => "resourceName",
    :value => "value",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



714
715
716
717
718
719
720
721
722
723
 
# File 'elastic_beanstalk/cfn_environment.rb', line 714

def to_jsii
  result = {}
  result.merge!({
    "namespace" => @namespace,
    "optionName" => @option_name,
    "resourceName" => @resource_name,
    "value" => @value,
  })
  result.compact
end