Skip to content

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines

Description

Describes the configuration options that are used in a particular configuration template or environment, or that a specified solution stack defines. The description includes the values the options, their default values, and an indication of the required action on a running environment if an option value is changed.

This action only returns information about resources that the calling principle has IAM permissions to access. For example, consider a case where a user only has permission to access one of three resources. When the user calls the this action, the response will only include the one resource that the user has permission to access instead of all three resources. If the user doesn’t have access to any of the resources an empty result is returned.

The AWSElasticBeanstalkReadOnly managed policy allows operators to view information about resources related to Elastic Beanstalk. For more information, see Managing Elastic Beanstalk user policies in the Elastic Beanstalk Developer Guide. For detailed instructions to attach a policy to a user or group, see the section Controlling access with managed policies in the same topic.

Usage

elasticbeanstalk_describe_configuration_options(ApplicationName,
  TemplateName, EnvironmentName, SolutionStackName, PlatformArn, Options)

Arguments

  • ApplicationName

    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.

  • TemplateName

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

  • EnvironmentName

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

  • SolutionStackName

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

  • PlatformArn

    The ARN of the custom platform.

  • Options

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

Value

A list with the following syntax:

list(
  SolutionStackName = "string",
  PlatformArn = "string",
  Options = list(
    list(
      Namespace = "string",
      Name = "string",
      DefaultValue = "string",
      ChangeSeverity = "string",
      UserDefined = TRUE|FALSE,
      ValueType = "Scalar"|"List",
      ValueOptions = list(
        "string"
      ),
      MinValue = 123,
      MaxValue = 123,
      MaxLength = 123,
      Regex = list(
        Pattern = "string",
        Label = "string"
      )
    )
  )
)

Request syntax

svc$describe_configuration_options(
  ApplicationName = "string",
  TemplateName = "string",
  EnvironmentName = "string",
  SolutionStackName = "string",
  PlatformArn = "string",
  Options = list(
    list(
      ResourceName = "string",
      Namespace = "string",
      OptionName = "string"
    )
  )
)

Examples

# The following operation retrieves descriptions of all available
# configuration options for an environment named my-env:
svc$describe_configuration_options(
  ApplicationName = "my-app",
  EnvironmentName = "my-env"
)