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.
-
#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.
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 486 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the configuration profile.
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 486 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type) SENSITIVE = [] include Aws::Structure end |
#location_uri ⇒ String
A URI to locate the configuration. You can specify the AppConfig
hosted configuration store, Systems Manager (SSM) document, an SSM
Parameter Store parameter, or an Amazon S3 object. For the hosted
configuration store and for feature flags, specify hosted
. For an
SSM document, specify either the document name in the format
ssm-document://<Document_name>
or the Amazon Resource Name (ARN).
For a parameter, specify either the parameter name in the format
ssm-parameter://<Parameter_name>
or the ARN. 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
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 486 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
A name for the configuration profile.
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 486 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type) 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.
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 486 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type) 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.
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 486 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type) 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
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 486 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type) SENSITIVE = [] include Aws::Structure end |
#validators ⇒ Array<Types::Validator>
A list of methods for validating the configuration.
486 487 488 489 490 491 492 493 494 495 496 497 |
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 486 class CreateConfigurationProfileRequest < Struct.new( :application_id, :name, :description, :location_uri, :retrieval_role_arn, :validators, :tags, :type) SENSITIVE = [] include Aws::Structure end |