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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#applicationString

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

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1523

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

#client_configuration_versionString

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 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 the Configuration in the AppConfig User Guide.

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1523

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

#client_idString

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)


1523
1524
1525
1526
1527
1528
1529
1530
1531
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1523

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

#configurationString

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

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1523

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

#environmentString

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

Returns:

  • (String)


1523
1524
1525
1526
1527
1528
1529
1530
1531
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1523

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