You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::ElasticBeanstalk::Types::DescribeConfigurationOptionsMessage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb

Overview

Note:

When making an API call, you may pass DescribeConfigurationOptionsMessage data as a hash:

{
  application_name: "ApplicationName",
  template_name: "ConfigurationTemplateName",
  environment_name: "EnvironmentName",
  solution_stack_name: "SolutionStackName",
  platform_arn: "PlatformArn",
  options: [
    {
      resource_name: "ResourceName",
      namespace: "OptionNamespace",
      option_name: "ConfigurationOptionName",
    },
  ],
}

Result message containing a list of application version descriptions.

Instance Attribute Summary collapse

Instance Attribute Details

#application_nameString

The name of the application associated with the configuration template or environment. Only needed if you want to describe the configuration options associated with either the configuration template or environment.

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1710

class DescribeConfigurationOptionsMessage < Struct.new(
  :application_name,
  :template_name,
  :environment_name,
  :solution_stack_name,
  :platform_arn,
  :options)
  include Aws::Structure
end

#environment_nameString

The name of the environment whose configuration options you want to describe.

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1710

class DescribeConfigurationOptionsMessage < Struct.new(
  :application_name,
  :template_name,
  :environment_name,
  :solution_stack_name,
  :platform_arn,
  :options)
  include Aws::Structure
end

#optionsArray<Types::OptionSpecification>

If specified, restricts the descriptions to only the specified options.

Returns:



1710
1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1710

class DescribeConfigurationOptionsMessage < Struct.new(
  :application_name,
  :template_name,
  :environment_name,
  :solution_stack_name,
  :platform_arn,
  :options)
  include Aws::Structure
end

#platform_arnString

The ARN of the custom platform.

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1710

class DescribeConfigurationOptionsMessage < Struct.new(
  :application_name,
  :template_name,
  :environment_name,
  :solution_stack_name,
  :platform_arn,
  :options)
  include Aws::Structure
end

#solution_stack_nameString

The name of the solution stack whose configuration options you want to describe.

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1710

class DescribeConfigurationOptionsMessage < Struct.new(
  :application_name,
  :template_name,
  :environment_name,
  :solution_stack_name,
  :platform_arn,
  :options)
  include Aws::Structure
end

#template_nameString

The name of the configuration template whose configuration options you want to describe.

Returns:

  • (String)


1710
1711
1712
1713
1714
1715
1716
1717
1718
# File 'gems/aws-sdk-elasticbeanstalk/lib/aws-sdk-elasticbeanstalk/types.rb', line 1710

class DescribeConfigurationOptionsMessage < Struct.new(
  :application_name,
  :template_name,
  :environment_name,
  :solution_stack_name,
  :platform_arn,
  :options)
  include Aws::Structure
end