Skip to content

Describe Configuration Settings

elasticbeanstalk_describe_configuration_settings R Documentation

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment

Description

Returns a description of the settings for the specified configuration set, that is, either a configuration template or the configuration set associated with a running environment.

When describing the settings for the configuration set associated with a running environment, it is possible to receive two sets of setting descriptions. One is the deployed configuration set, and the other is a draft configuration of an environment that is either in the process of deployment or that failed to deploy.

Related Topics

  • delete_environment_configuration

Usage

elasticbeanstalk_describe_configuration_settings(ApplicationName,
  TemplateName, EnvironmentName)

Arguments

ApplicationName

[required] The application for the environment or configuration template.

TemplateName

The name of the configuration template to describe.

Conditional: You must specify either this parameter or an EnvironmentName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns a MissingRequiredParameter error.

EnvironmentName

The name of the environment to describe.

Condition: You must specify either this or a TemplateName, but not both. If you specify both, AWS Elastic Beanstalk returns an InvalidParameterCombination error. If you do not specify either, AWS Elastic Beanstalk returns MissingRequiredParameter error.

Value

A list with the following syntax: 

list(
  ConfigurationSettings = list(
    list(
      SolutionStackName = "string",
      PlatformArn = "string",
      ApplicationName = "string",
      TemplateName = "string",
      Description = "string",
      EnvironmentName = "string",
      DeploymentStatus = "deployed"|"pending"|"failed",
      DateCreated = as.POSIXct(
        "2015-01-01"
      ),
      DateUpdated = as.POSIXct(
        "2015-01-01"
      ),
      OptionSettings = list(
        list(
          ResourceName = "string",
          Namespace = "string",
          OptionName = "string",
          Value = "string"
        )
      )
    )
  )
)

Request syntax

svc$describe_configuration_settings(
  ApplicationName = "string",
  TemplateName = "string",
  EnvironmentName = "string"
)

Examples

## Not run: 
# The following operation retrieves configuration settings for an
# environment named my-env:
svc$describe_configuration_settings(
  ApplicationName = "my-app",
  EnvironmentName = "my-env"
)

## End(Not run)