Class: Aws::AppConfig::Types::GetConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::AppConfig::Types::GetConfigurationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-appconfig/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application ⇒ String

  The application to get.

• #client_configuration_version ⇒ String

  The configuration version returned in the most recent GetConfiguration response.

• #client_id ⇒ String

  The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration.

• #configuration ⇒ String

  The configuration to get.

• #environment ⇒ String

  The environment to get.

Instance Attribute Details

#application ⇒ String

The application to get. Specify either the application name or the application ID.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 1704

class GetConfigurationRequest < Struct.new(
  :application,
  :environment,
  :configuration,
  :client_id,
  :client_configuration_version)
  SENSITIVE = []
  include Aws::Structure
end

#client_configuration_version ⇒ String

The configuration version returned in the most recent GetConfiguration response.

AppConfig uses the value of the ‘ClientConfigurationVersion` parameter to identify the configuration version on your clients. If you don’t send `ClientConfigurationVersion` with each call to GetConfiguration, your clients receive the current configuration. You are charged each time your clients receive a configuration.

To avoid excess charges, we recommend you use the

StartConfigurationSession][1

and [GetLatestConfiguration] APIs,

which track the client configuration version on your behalf. If you choose to continue using GetConfiguration, we recommend that you include the ‘ClientConfigurationVersion` value with every call to GetConfiguration. The value to use for `ClientConfigurationVersion` comes from the `ConfigurationVersion` attribute returned by GetConfiguration when there is new or updated data, and should be saved for subsequent calls to GetConfiguration.

For more information about working with configurations, see

Retrieving feature flags and configuration data in AppConfig][3

in

the *AppConfig User Guide*.

[1]: docs.aws.amazon.com/appconfig/2019-10-09/APIReference/StartConfigurationSession.html [2]: docs.aws.amazon.com/appconfig/2019-10-09/APIReference/GetLatestConfiguration.html [3]: docs.aws.amazon.com/appconfig/latest/userguide/retrieving-feature-flags.html

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 1704

class GetConfigurationRequest < Struct.new(
  :application,
  :environment,
  :configuration,
  :client_id,
  :client_configuration_version)
  SENSITIVE = []
  include Aws::Structure
end

#client_id ⇒ String

The clientId parameter in the following command is a unique, user-specified ID to identify the client for the configuration. This ID enables AppConfig to deploy the configuration in intervals, as defined in the deployment strategy.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 1704

class GetConfigurationRequest < Struct.new(
  :application,
  :environment,
  :configuration,
  :client_id,
  :client_configuration_version)
  SENSITIVE = []
  include Aws::Structure
end

#configuration ⇒ String

The configuration to get. Specify either the configuration name or the configuration ID.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 1704

class GetConfigurationRequest < Struct.new(
  :application,
  :environment,
  :configuration,
  :client_id,
  :client_configuration_version)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ String

The environment to get. Specify either the environment name or the environment ID.

Returns:

• (String)

# File 'lib/aws-sdk-appconfig/types.rb', line 1704

class GetConfigurationRequest < Struct.new(
  :application,
  :environment,
  :configuration,
  :client_id,
  :client_configuration_version)
  SENSITIVE = []
  include Aws::Structure
end