1. Packages
  2. AWS Classic
  3. API Docs
  4. appconfig
  5. ConfigurationProfile

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

aws.appconfig.ConfigurationProfile

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi

    Provides an AppConfig Configuration Profile resource.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.appconfig.ConfigurationProfile("example", {
        applicationId: exampleAwsAppconfigApplication.id,
        description: "Example Configuration Profile",
        name: "example-configuration-profile-tf",
        locationUri: "hosted",
        validators: [{
            content: exampleAwsLambdaFunction.arn,
            type: "LAMBDA",
        }],
        tags: {
            Type: "AppConfig Configuration Profile",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.appconfig.ConfigurationProfile("example",
        application_id=example_aws_appconfig_application["id"],
        description="Example Configuration Profile",
        name="example-configuration-profile-tf",
        location_uri="hosted",
        validators=[{
            "content": example_aws_lambda_function["arn"],
            "type": "LAMBDA",
        }],
        tags={
            "Type": "AppConfig Configuration Profile",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appconfig"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := appconfig.NewConfigurationProfile(ctx, "example", &appconfig.ConfigurationProfileArgs{
    			ApplicationId: pulumi.Any(exampleAwsAppconfigApplication.Id),
    			Description:   pulumi.String("Example Configuration Profile"),
    			Name:          pulumi.String("example-configuration-profile-tf"),
    			LocationUri:   pulumi.String("hosted"),
    			Validators: appconfig.ConfigurationProfileValidatorArray{
    				&appconfig.ConfigurationProfileValidatorArgs{
    					Content: pulumi.Any(exampleAwsLambdaFunction.Arn),
    					Type:    pulumi.String("LAMBDA"),
    				},
    			},
    			Tags: pulumi.StringMap{
    				"Type": pulumi.String("AppConfig Configuration Profile"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.AppConfig.ConfigurationProfile("example", new()
        {
            ApplicationId = exampleAwsAppconfigApplication.Id,
            Description = "Example Configuration Profile",
            Name = "example-configuration-profile-tf",
            LocationUri = "hosted",
            Validators = new[]
            {
                new Aws.AppConfig.Inputs.ConfigurationProfileValidatorArgs
                {
                    Content = exampleAwsLambdaFunction.Arn,
                    Type = "LAMBDA",
                },
            },
            Tags = 
            {
                { "Type", "AppConfig Configuration Profile" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appconfig.ConfigurationProfile;
    import com.pulumi.aws.appconfig.ConfigurationProfileArgs;
    import com.pulumi.aws.appconfig.inputs.ConfigurationProfileValidatorArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new ConfigurationProfile("example", ConfigurationProfileArgs.builder()
                .applicationId(exampleAwsAppconfigApplication.id())
                .description("Example Configuration Profile")
                .name("example-configuration-profile-tf")
                .locationUri("hosted")
                .validators(ConfigurationProfileValidatorArgs.builder()
                    .content(exampleAwsLambdaFunction.arn())
                    .type("LAMBDA")
                    .build())
                .tags(Map.of("Type", "AppConfig Configuration Profile"))
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:appconfig:ConfigurationProfile
        properties:
          applicationId: ${exampleAwsAppconfigApplication.id}
          description: Example Configuration Profile
          name: example-configuration-profile-tf
          locationUri: hosted
          validators:
            - content: ${exampleAwsLambdaFunction.arn}
              type: LAMBDA
          tags:
            Type: AppConfig Configuration Profile
    

    Create ConfigurationProfile Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ConfigurationProfile(name: string, args: ConfigurationProfileArgs, opts?: CustomResourceOptions);
    @overload
    def ConfigurationProfile(resource_name: str,
                             args: ConfigurationProfileArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def ConfigurationProfile(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             application_id: Optional[str] = None,
                             location_uri: Optional[str] = None,
                             description: Optional[str] = None,
                             kms_key_identifier: Optional[str] = None,
                             name: Optional[str] = None,
                             retrieval_role_arn: Optional[str] = None,
                             tags: Optional[Mapping[str, str]] = None,
                             type: Optional[str] = None,
                             validators: Optional[Sequence[ConfigurationProfileValidatorArgs]] = None)
    func NewConfigurationProfile(ctx *Context, name string, args ConfigurationProfileArgs, opts ...ResourceOption) (*ConfigurationProfile, error)
    public ConfigurationProfile(string name, ConfigurationProfileArgs args, CustomResourceOptions? opts = null)
    public ConfigurationProfile(String name, ConfigurationProfileArgs args)
    public ConfigurationProfile(String name, ConfigurationProfileArgs args, CustomResourceOptions options)
    
    type: aws:appconfig:ConfigurationProfile
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ConfigurationProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ConfigurationProfileArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ConfigurationProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConfigurationProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConfigurationProfileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var configurationProfileResource = new Aws.AppConfig.ConfigurationProfile("configurationProfileResource", new()
    {
        ApplicationId = "string",
        LocationUri = "string",
        Description = "string",
        KmsKeyIdentifier = "string",
        Name = "string",
        RetrievalRoleArn = "string",
        Tags = 
        {
            { "string", "string" },
        },
        Type = "string",
        Validators = new[]
        {
            new Aws.AppConfig.Inputs.ConfigurationProfileValidatorArgs
            {
                Type = "string",
                Content = "string",
            },
        },
    });
    
    example, err := appconfig.NewConfigurationProfile(ctx, "configurationProfileResource", &appconfig.ConfigurationProfileArgs{
    	ApplicationId:    pulumi.String("string"),
    	LocationUri:      pulumi.String("string"),
    	Description:      pulumi.String("string"),
    	KmsKeyIdentifier: pulumi.String("string"),
    	Name:             pulumi.String("string"),
    	RetrievalRoleArn: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Type: pulumi.String("string"),
    	Validators: appconfig.ConfigurationProfileValidatorArray{
    		&appconfig.ConfigurationProfileValidatorArgs{
    			Type:    pulumi.String("string"),
    			Content: pulumi.String("string"),
    		},
    	},
    })
    
    var configurationProfileResource = new ConfigurationProfile("configurationProfileResource", ConfigurationProfileArgs.builder()
        .applicationId("string")
        .locationUri("string")
        .description("string")
        .kmsKeyIdentifier("string")
        .name("string")
        .retrievalRoleArn("string")
        .tags(Map.of("string", "string"))
        .type("string")
        .validators(ConfigurationProfileValidatorArgs.builder()
            .type("string")
            .content("string")
            .build())
        .build());
    
    configuration_profile_resource = aws.appconfig.ConfigurationProfile("configurationProfileResource",
        application_id="string",
        location_uri="string",
        description="string",
        kms_key_identifier="string",
        name="string",
        retrieval_role_arn="string",
        tags={
            "string": "string",
        },
        type="string",
        validators=[{
            "type": "string",
            "content": "string",
        }])
    
    const configurationProfileResource = new aws.appconfig.ConfigurationProfile("configurationProfileResource", {
        applicationId: "string",
        locationUri: "string",
        description: "string",
        kmsKeyIdentifier: "string",
        name: "string",
        retrievalRoleArn: "string",
        tags: {
            string: "string",
        },
        type: "string",
        validators: [{
            type: "string",
            content: "string",
        }],
    });
    
    type: aws:appconfig:ConfigurationProfile
    properties:
        applicationId: string
        description: string
        kmsKeyIdentifier: string
        locationUri: string
        name: string
        retrievalRoleArn: string
        tags:
            string: string
        type: string
        validators:
            - content: string
              type: string
    

    ConfigurationProfile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ConfigurationProfile resource accepts the following input properties:

    ApplicationId string
    Application ID. Must be between 4 and 7 characters in length.
    LocationUri string
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    Description string
    Description of the configuration profile. Can be at most 1024 characters.
    KmsKeyIdentifier 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.
    Name string
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    RetrievalRoleArn string
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Type string
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    Validators List<ConfigurationProfileValidator>
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    ApplicationId string
    Application ID. Must be between 4 and 7 characters in length.
    LocationUri string
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    Description string
    Description of the configuration profile. Can be at most 1024 characters.
    KmsKeyIdentifier 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.
    Name string
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    RetrievalRoleArn string
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    Type string
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    Validators []ConfigurationProfileValidatorArgs
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    applicationId String
    Application ID. Must be between 4 and 7 characters in length.
    locationUri String
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    description String
    Description of the configuration profile. Can be at most 1024 characters.
    kmsKeyIdentifier 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.
    name String
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    retrievalRoleArn String
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    validators List<ConfigurationProfileValidator>
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    applicationId string
    Application ID. Must be between 4 and 7 characters in length.
    locationUri string
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    description string
    Description of the configuration profile. Can be at most 1024 characters.
    kmsKeyIdentifier 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.
    name string
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    retrievalRoleArn string
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type string
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    validators ConfigurationProfileValidator[]
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    application_id str
    Application ID. Must be between 4 and 7 characters in length.
    location_uri str
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    description str
    Description of the configuration profile. Can be at most 1024 characters.
    kms_key_identifier str
    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.
    name str
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    retrieval_role_arn str
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type str
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    validators Sequence[ConfigurationProfileValidatorArgs]
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    applicationId String
    Application ID. Must be between 4 and 7 characters in length.
    locationUri String
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    description String
    Description of the configuration profile. Can be at most 1024 characters.
    kmsKeyIdentifier 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.
    name String
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    retrievalRoleArn String
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    type String
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    validators List<Property Map>
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ConfigurationProfile resource produces the following output properties:

    Arn string
    ARN of the AppConfig Configuration Profile.
    ConfigurationProfileId string
    The configuration profile ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the AppConfig Configuration Profile.
    ConfigurationProfileId string
    The configuration profile ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the AppConfig Configuration Profile.
    configurationProfileId String
    The configuration profile ID.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the AppConfig Configuration Profile.
    configurationProfileId string
    The configuration profile ID.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the AppConfig Configuration Profile.
    configuration_profile_id str
    The configuration profile ID.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the AppConfig Configuration Profile.
    configurationProfileId String
    The configuration profile ID.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up Existing ConfigurationProfile Resource

    Get an existing ConfigurationProfile resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ConfigurationProfileState, opts?: CustomResourceOptions): ConfigurationProfile
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            application_id: Optional[str] = None,
            arn: Optional[str] = None,
            configuration_profile_id: Optional[str] = None,
            description: Optional[str] = None,
            kms_key_identifier: Optional[str] = None,
            location_uri: Optional[str] = None,
            name: Optional[str] = None,
            retrieval_role_arn: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None,
            type: Optional[str] = None,
            validators: Optional[Sequence[ConfigurationProfileValidatorArgs]] = None) -> ConfigurationProfile
    func GetConfigurationProfile(ctx *Context, name string, id IDInput, state *ConfigurationProfileState, opts ...ResourceOption) (*ConfigurationProfile, error)
    public static ConfigurationProfile Get(string name, Input<string> id, ConfigurationProfileState? state, CustomResourceOptions? opts = null)
    public static ConfigurationProfile get(String name, Output<String> id, ConfigurationProfileState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApplicationId string
    Application ID. Must be between 4 and 7 characters in length.
    Arn string
    ARN of the AppConfig Configuration Profile.
    ConfigurationProfileId string
    The configuration profile ID.
    Description string
    Description of the configuration profile. Can be at most 1024 characters.
    KmsKeyIdentifier 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.
    LocationUri string
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    Name string
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    RetrievalRoleArn string
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    Tags Dictionary<string, string>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    Validators List<ConfigurationProfileValidator>
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    ApplicationId string
    Application ID. Must be between 4 and 7 characters in length.
    Arn string
    ARN of the AppConfig Configuration Profile.
    ConfigurationProfileId string
    The configuration profile ID.
    Description string
    Description of the configuration profile. Can be at most 1024 characters.
    KmsKeyIdentifier 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.
    LocationUri string
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    Name string
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    RetrievalRoleArn string
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    Tags map[string]string
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Type string
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    Validators []ConfigurationProfileValidatorArgs
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    applicationId String
    Application ID. Must be between 4 and 7 characters in length.
    arn String
    ARN of the AppConfig Configuration Profile.
    configurationProfileId String
    The configuration profile ID.
    description String
    Description of the configuration profile. Can be at most 1024 characters.
    kmsKeyIdentifier 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.
    locationUri String
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    name String
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    retrievalRoleArn String
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    tags Map<String,String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    validators List<ConfigurationProfileValidator>
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    applicationId string
    Application ID. Must be between 4 and 7 characters in length.
    arn string
    ARN of the AppConfig Configuration Profile.
    configurationProfileId string
    The configuration profile ID.
    description string
    Description of the configuration profile. Can be at most 1024 characters.
    kmsKeyIdentifier 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.
    locationUri string
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    name string
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    retrievalRoleArn string
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    tags {[key: string]: string}
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type string
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    validators ConfigurationProfileValidator[]
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    application_id str
    Application ID. Must be between 4 and 7 characters in length.
    arn str
    ARN of the AppConfig Configuration Profile.
    configuration_profile_id str
    The configuration profile ID.
    description str
    Description of the configuration profile. Can be at most 1024 characters.
    kms_key_identifier str
    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.
    location_uri str
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    name str
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    retrieval_role_arn str
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    tags Mapping[str, str]
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type str
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    validators Sequence[ConfigurationProfileValidatorArgs]
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.
    applicationId String
    Application ID. Must be between 4 and 7 characters in length.
    arn String
    ARN of the AppConfig Configuration Profile.
    configurationProfileId String
    The configuration profile ID.
    description String
    Description of the configuration profile. Can be at most 1024 characters.
    kmsKeyIdentifier 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.
    locationUri String
    URI to locate the configuration. You can specify the AWS AppConfig hosted configuration store, Systems Manager (SSM) document, an SSM Parameter Store parameter, or an Amazon S3 object. For the hosted configuration store, specify hosted. For an SSM document, specify either the document name in the format ssm-document://<Document_name> or the 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>.
    name String
    Name for the configuration profile. Must be between 1 and 64 characters in length.
    retrievalRoleArn String
    ARN of an IAM role with permission to access the configuration at the specified location_uri. A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
    tags Map<String>
    Map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    type String
    Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
    validators List<Property Map>
    Set of methods for validating the configuration. Maximum of 2. See Validator below for more details.

    Supporting Types

    ConfigurationProfileValidator, ConfigurationProfileValidatorArgs

    Type string
    Type of validator. Valid values: JSON_SCHEMA and LAMBDA.
    Content string
    Either the JSON Schema content or the ARN of an AWS Lambda function.
    Type string
    Type of validator. Valid values: JSON_SCHEMA and LAMBDA.
    Content string
    Either the JSON Schema content or the ARN of an AWS Lambda function.
    type String
    Type of validator. Valid values: JSON_SCHEMA and LAMBDA.
    content String
    Either the JSON Schema content or the ARN of an AWS Lambda function.
    type string
    Type of validator. Valid values: JSON_SCHEMA and LAMBDA.
    content string
    Either the JSON Schema content or the ARN of an AWS Lambda function.
    type str
    Type of validator. Valid values: JSON_SCHEMA and LAMBDA.
    content str
    Either the JSON Schema content or the ARN of an AWS Lambda function.
    type String
    Type of validator. Valid values: JSON_SCHEMA and LAMBDA.
    content String
    Either the JSON Schema content or the ARN of an AWS Lambda function.

    Import

    Using pulumi import, import AppConfig Configuration Profiles using the configuration profile ID and application ID separated by a colon (:). For example:

    $ pulumi import aws:appconfig/configurationProfile:ConfigurationProfile example 71abcde:11xxxxx
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.42.0 published on Wednesday, Jun 26, 2024 by Pulumi