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

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

Overview

Note:

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

{
  application: "StringWithLengthBetween1And64", # required
  environment: "StringWithLengthBetween1And64", # required
  configuration: "StringWithLengthBetween1And64", # required
  client_id: "StringWithLengthBetween1And64", # required
  client_configuration_version: "Version",
}

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)


1175
1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1175

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 that you include the ClientConfigurationVersion value with every call to GetConfiguration. This value must be saved on your client. Subsequent calls to GetConfiguration must pass this value by using the ClientConfigurationVersion parameter.

For more information about working with configurations, see Retrieving the Configuration in the AppConfig User Guide.

Returns:

  • (String)


1175
1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1175

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)


1175
1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1175

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)


1175
1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1175

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)


1175
1176
1177
1178
1179
1180
1181
1182
1183
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 1175

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