Class: AWSCDK::ElasticBeanstalk::CfnConfigurationTemplateProps

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

Overview

Properties for defining a CfnConfigurationTemplate.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(application_name:, description: nil, environment_id: nil, option_settings: nil, platform_arn: nil, solution_stack_name: nil, source_configuration: nil) ⇒ CfnConfigurationTemplateProps

Returns a new instance of CfnConfigurationTemplateProps.

Parameters:



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 16

def initialize(application_name:, description: nil, environment_id: nil, option_settings: nil, platform_arn: nil, solution_stack_name: nil, source_configuration: nil)
  @application_name = application_name
  Jsii::Type.check_type(@application_name, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoic3RyaW5nIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19lbGFzdGljYmVhbnN0YWxrLklBcHBsaWNhdGlvblJlZiJ9XX19")), "applicationName")
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @environment_id = environment_id
  Jsii::Type.check_type(@environment_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "environmentId") unless @environment_id.nil?
  @option_settings = option_settings
  Jsii::Type.check_type(@option_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2JlYW5zdGFsay5DZm5Db25maWd1cmF0aW9uVGVtcGxhdGUuQ29uZmlndXJhdGlvbk9wdGlvblNldHRpbmdQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "optionSettings") unless @option_settings.nil?
  @platform_arn = platform_arn
  Jsii::Type.check_type(@platform_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "platformArn") unless @platform_arn.nil?
  @solution_stack_name = solution_stack_name
  Jsii::Type.check_type(@solution_stack_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "solutionStackName") unless @solution_stack_name.nil?
  @source_configuration = source_configuration.is_a?(Hash) ? ::AWSCDK::ElasticBeanstalk::CfnConfigurationTemplate::SourceConfigurationProperty.new(**source_configuration.transform_keys(&:to_sym)) : source_configuration
  Jsii::Type.check_type(@source_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lbGFzdGljYmVhbnN0YWxrLkNmbkNvbmZpZ3VyYXRpb25UZW1wbGF0ZS5Tb3VyY2VDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "sourceConfiguration") unless @source_configuration.nil?
end

Instance Attribute Details

#application_name ⇒ String, AWSCDK::Interfaces::AWSElasticbeanstalk::IApplicationRef (readonly)

The name of the Elastic Beanstalk application to associate with this configuration template.

Returns:

See Also:



37
38
39
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 37

def application_name
  @application_name
end

#description ⇒ String? (readonly)

An optional description for this configuration.

Returns:

  • (String, nil)

See Also:



42
43
44
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 42

def description
  @description
end

#environment_id ⇒ String? (readonly)

The ID of an environment whose settings you want to use to create the configuration template.

You must specify EnvironmentId if you don't specify PlatformArn , SolutionStackName , or SourceConfiguration .

Returns:

  • (String, nil)

See Also:



49
50
51
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 49

def environment_id
  @environment_id
end

#option_settings ⇒ AWSCDK::IResolvable, ... (readonly)

Option values for the Elastic Beanstalk configuration, such as the instance type.

If specified, these values override the values obtained from the solution stack or the source configuration template. For a complete list of Elastic Beanstalk configuration options, see Option Values in the AWS Elastic Beanstalk Developer Guide .

Returns:

See Also:



56
57
58
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 56

def option_settings
  @option_settings
end

#platform_arn ⇒ String? (readonly)

The Amazon Resource Name (ARN) of the custom platform.

For more information, see Custom Platforms in the AWS Elastic Beanstalk Developer Guide .

If you specify PlatformArn , then don't specify SolutionStackName .

Returns:

  • (String, nil)

See Also:



65
66
67
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 65

def platform_arn
  @platform_arn
end

#solution_stack_name ⇒ String? (readonly)

The name of an Elastic Beanstalk solution stack (platform version) that this configuration uses.

For example, 64bit Amazon Linux 2013.09 running Tomcat 7 Java 7 . A solution stack specifies the operating system, runtime, and application server for a configuration template. It also determines the set of configuration options as well as the possible and default values. For more information, see Supported Platforms in the AWS Elastic Beanstalk Developer Guide .

You must specify SolutionStackName if you don't specify PlatformArn , EnvironmentId , or SourceConfiguration .

Use the ListAvailableSolutionStacks API to obtain a list of available solution stacks.

Returns:

  • (String, nil)

See Also:



76
77
78
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 76

def solution_stack_name
  @solution_stack_name
end

#source_configuration ⇒ AWSCDK::IResolvable, ... (readonly)

An Elastic Beanstalk configuration template to base this one on.

If specified, Elastic Beanstalk uses the configuration values from the specified configuration template to create a new configuration.

Values specified in OptionSettings override any values obtained from the SourceConfiguration .

You must specify SourceConfiguration if you don't specify PlatformArn , EnvironmentId , or SolutionStackName .

Constraint: If both solution stack name and source configuration are specified, the solution stack of the source configuration template must match the specified solution stack name.

Returns:

See Also:



89
90
91
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 89

def source_configuration
  @source_configuration
end

Class Method Details

.jsii_properties ⇒ Object 



91
92
93
94
95
96
97
98
99
100
101
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 91

def self.jsii_properties
  {
    :application_name => "applicationName",
    :description => "description",
    :environment_id => "environmentId",
    :option_settings => "optionSettings",
    :platform_arn => "platformArn",
    :solution_stack_name => "solutionStackName",
    :source_configuration => "sourceConfiguration",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'elastic_beanstalk/cfn_configuration_template_props.rb', line 103

def to_jsii
  result = {}
  result.merge!({
    "applicationName" => @application_name,
    "description" => @description,
    "environmentId" => @environment_id,
    "optionSettings" => @option_settings,
    "platformArn" => @platform_arn,
    "solutionStackName" => @solution_stack_name,
    "sourceConfiguration" => @source_configuration,
  })
  result.compact
end