Class: Aws::AppConfig::Types::ConfigurationProfile

Inherits:

Struct

• Object
• Struct
• Aws::AppConfig::Types::ConfigurationProfile

Includes:

Structure

Defined in:

lib/aws-sdk-appconfig/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #application_id ⇒ String

  The application ID.

• #description ⇒ String

  The configuration profile description.

• #id ⇒ String

  The configuration profile ID.

• #kms_key_arn ⇒ String

  The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store.

• #kms_key_identifier ⇒ String

  The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

• #location_uri ⇒ String

  The URI location of the configuration.

• #name ⇒ String

  The name of the configuration profile.

• #retrieval_role_arn ⇒ String

  The ARN of an IAM role with permission to access the configuration at the specified ‘LocationUri`.

• #type ⇒ String

  The type of configurations contained in the profile.

• #validators ⇒ Array<Types::Validator>

  A list of methods for validating the configuration.

Instance Attribute Details

#application_id ⇒ String

The application ID.

Returns:

• (String)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The configuration profile description.

Returns:

• (String)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#id ⇒ String

The configuration profile ID.

Returns:

• (String)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_arn ⇒ String

The Amazon Resource Name of the Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store. This attribute is only used for ‘hosted` configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.

Returns:

• (String)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#kms_key_identifier ⇒ String

The Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.

Returns:

• (String)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#location_uri ⇒ String

The URI location of the configuration.

Returns:

• (String)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the configuration profile.

Returns:

• (String)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#retrieval_role_arn ⇒ String

The ARN of an IAM role with permission to access the configuration at the specified ‘LocationUri`.

Returns:

• (String)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

The type of configurations contained in the profile. AppConfig supports ‘feature flags` and `freeform` configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for `Type`:

‘AWS.AppConfig.FeatureFlags`

‘AWS.Freeform`

Returns:

• (String)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end

#validators ⇒ Array<Types::Validator>

A list of methods for validating the configuration.

Returns:

• (Array<Types::Validator>)

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

class ConfigurationProfile < Struct.new(
  :application_id,
  :id,
  :name,
  :description,
  :location_uri,
  :retrieval_role_arn,
  :validators,
  :type,
  :kms_key_arn,
  :kms_key_identifier)
  SENSITIVE = []
  include Aws::Structure
end