Class: Aws::AppConfig::Types::CreateConfigurationProfileRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppConfig::Types::CreateConfigurationProfileRequest
- Defined in:
- gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb
Overview
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#application_id ⇒ String
The application ID.
-
#description ⇒ String
A description of the configuration profile.
-
#kms_key_identifier ⇒ String
The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store.
-
#location_uri ⇒ String
A URI to locate the configuration.
-
#name ⇒ String
A name for the configuration profile.
-
#retrieval_role_arn ⇒ String
The ARN of an IAM role with permission to access the configuration at the specified
LocationUri
. -
#tags ⇒ Hash<String,String>
Metadata to assign to the configuration profile.
-
#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.
545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 545 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type, :kms_key_identifier) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the configuration profile.
545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 545 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type, :kms_key_identifier) SENSITIVE = [] include Aws::Structure end |
#kms_key_identifier ⇒ String
The identifier for an 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.
The identifier can be an KMS key ID, alias, or the Amazon Resource
Name (ARN) of the key ID or alias. To encrypt data managed in other
configuration stores, see the documentation for how to specify an
KMS key for that particular service.
545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 545 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type, :kms_key_identifier) SENSITIVE = [] include Aws::Structure end |
#location_uri ⇒ String
A URI to locate the configuration. You can specify the following:
For the AppConfig hosted configuration store and for feature flags, specify
hosted
.For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format
ssm-parameter://<parameter name>
or the ARN.For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format:
codepipeline
://<pipeline name>.For an Secrets Manager secret, specify the URI in the following format:
secretsmanager
://<secret name>.For an Amazon S3 object, specify the URI in the following format:
s3://<bucket>/<objectKey>
. Here is an example:s3://my-bucket/my-app/us-east-1/my-config.json
For an SSM document, specify either the document name in the format
ssm-document://<document name>
or the Amazon Resource Name (ARN).
545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 545 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type, :kms_key_identifier) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A name for the configuration profile.
545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 545 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type, :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
.
A retrieval role ARN is not required for configurations stored in the AppConfig hosted configuration store. It is required for all other sources that store your configuration.
545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 545 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type, :kms_key_identifier) SENSITIVE = [] include Aws::Structure end |
#tags ⇒ Hash<String,String>
Metadata to assign to the configuration profile. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 545 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type, :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
545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 545 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type, :kms_key_identifier) SENSITIVE = [] include Aws::Structure end |
#validators ⇒ Array<Types::Validator>
A list of methods for validating the configuration.
545 546 547 548 549 550 551 552 553 554 555 556 557 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 545 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type, :kms_key_identifier) SENSITIVE = [] include Aws::Structure end |