Class: Aws::AppConfig::Types::CreateConfigurationProfileRequest

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 CreateConfigurationProfileRequest data as a hash:

{
  application_id: "Id", # required
  name: "Name", # required
  description: "Description",
  location_uri: "Uri", # required
  retrieval_role_arn: "RoleArn",
  validators: [
    {
      type: "JSON_SCHEMA", # required, accepts JSON_SCHEMA, LAMBDA
      content: "StringWithLengthBetween0And32768", # required
    },
  ],
  tags: {
    "TagKey" => "TagValue",
  },
  type: "ConfigurationProfileType",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#application_idString

The application ID.

Returns:

  • (String)


384
385
386
387
388
389
390
391
392
393
394
395
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 384

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

#descriptionString

A description of the configuration profile.

Returns:

  • (String)


384
385
386
387
388
389
390
391
392
393
394
395
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 384

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

#location_uriString

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

Returns:

  • (String)


384
385
386
387
388
389
390
391
392
393
394
395
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 384

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

#nameString

A name for the configuration profile.

Returns:

  • (String)


384
385
386
387
388
389
390
391
392
393
394
395
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 384

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

#retrieval_role_arnString

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.

Returns:

  • (String)


384
385
386
387
388
389
390
391
392
393
394
395
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 384

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

#tagsHash<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.

Returns:

  • (Hash<String,String>)


384
385
386
387
388
389
390
391
392
393
394
395
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 384

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

#typeString

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)


384
385
386
387
388
389
390
391
392
393
394
395
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 384

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

#validatorsArray<Types::Validator>

A list of methods for validating the configuration.

Returns:



384
385
386
387
388
389
390
391
392
393
394
395
# File 'gems/aws-sdk-appconfig/lib/aws-sdk-appconfig/types.rb', line 384

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