ConfigurationProfile class

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", {
    validators: [{
        content: exampleAwsLambdaFunction.arn,
        type: "LAMBDA",
    }],
    applicationId: exampleAwsAppconfigApplication.id,
    description: "Example Configuration Profile",
    name: "example-configuration-profile-tf",
    locationUri: "hosted",
    tags: {
        Type: "AppConfig Configuration Profile",
    },
});
import pulumi
import pulumi_aws as aws

example = aws.appconfig.ConfigurationProfile("example",
    validators=[{
        "content": example_aws_lambda_function["arn"],
        "type": "LAMBDA",
    }],
    application_id=example_aws_appconfig_application["id"],
    description="Example Configuration Profile",
    name="example-configuration-profile-tf",
    location_uri="hosted",
    tags={
        "Type": "AppConfig Configuration Profile",
    })
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()
    {
        Validators = new[]
        {
            new Aws.AppConfig.Inputs.ConfigurationProfileValidatorArgs
            {
                Content = exampleAwsLambdaFunction.Arn,
                Type = "LAMBDA",
            },
        },
        ApplicationId = exampleAwsAppconfigApplication.Id,
        Description = "Example Configuration Profile",
        Name = "example-configuration-profile-tf",
        LocationUri = "hosted",
        Tags =
        {
            { "Type", "AppConfig Configuration Profile" },
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			Validators: appconfig.ConfigurationProfileValidatorArray{
				&appconfig.ConfigurationProfileValidatorArgs{
					Content: pulumi.Any(exampleAwsLambdaFunction.Arn),
					Type:    pulumi.String("LAMBDA"),
				},
			},
			ApplicationId: pulumi.Any(exampleAwsAppconfigApplication.Id),
			Description:   pulumi.String("Example Configuration Profile"),
			Name:          pulumi.String("example-configuration-profile-tf"),
			LocationUri:   pulumi.String("hosted"),
			Tags: pulumi.StringMap{
				"Type": pulumi.String("AppConfig Configuration Profile"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_appconfig_configurationprofile" "example" {
  validators {
    content = exampleAwsLambdaFunction.arn
    type    = "LAMBDA"
  }
  application_id = exampleAwsAppconfigApplication.id
  description    = "Example Configuration Profile"
  name           = "example-configuration-profile-tf"
  location_uri   = "hosted"
  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.ArrayList;
import java.util.Arrays;
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()
            .validators(ConfigurationProfileValidatorArgs.builder()
                .content(exampleAwsLambdaFunction.arn())
                .type("LAMBDA")
                .build())
            .applicationId(exampleAwsAppconfigApplication.id())
            .description("Example Configuration Profile")
            .name("example-configuration-profile-tf")
            .locationUri("hosted")
            .tags(Map.of("Type", "AppConfig Configuration Profile"))
            .build());

    }
}
resources:
  example:
    type: aws:appconfig:ConfigurationProfile
    properties:
      validators:
        - content: ${exampleAwsLambdaFunction.arn}
          type: LAMBDA
      applicationId: ${exampleAwsAppconfigApplication.id}
      description: Example Configuration Profile
      name: example-configuration-profile-tf
      locationUri: hosted
      tags:
        Type: AppConfig Configuration Profile

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

Constructors

ConfigurationProfile(String name, {ConfigurationProfileArgs? args, CustomResourceOptions? options})
Creates a new ConfigurationProfile. name The Pulumi resource name. args Arguments used to configure this ConfigurationProfile. The set of arguments for ConfigurationProfile. options Resource options controlling this resource's behavior.
ConfigurationProfile.reference(String urn)
Creates a typed reference to an existing ConfigurationProfile resource.

Properties

applicationId ↔ Output<String>
Application ID. Must be between 4 and 7 characters in length.
latefinal
arn ↔ Output<String>
ARN of the AppConfig Configuration Profile.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
configurationProfileId ↔ Output<String>
Configuration profile ID.
latefinal
description ↔ Output<String?>
Description of the configuration profile. Can be at most 1024 characters.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
kmsKeyIdentifier ↔ Output<String?>
Identifier for a KMS 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 ARN of the key ID or alias.
latefinal
locationUri ↔ Output<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://&lt;Document_name&gt; or the ARN. For a parameter, specify either the parameter name in the format ssm-parameter://&lt;Parameter_name&gt; or the ARN. For an Amazon S3 object, specify the URI in the following format: s3://&lt;bucket&gt;/&lt;objectKey&gt;.
latefinal
name ↔ Output<String>
Name for the configuration profile. Must be between 1 and 128 characters in length.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
retrievalRoleArn ↔ Output<String?>
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 AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
tags ↔ Output<Map<String, String>?>
Map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
latefinal
tagsAll ↔ Output<Map<String, String>>
Map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
type ↔ Output<String?>
Type of configurations contained in the profile. Valid values: AWS.AppConfig.FeatureFlags and AWS.Freeform. Default: AWS.Freeform.
latefinal
urn ↔ Output<String>
latefinalinherited
validators ↔ Output<List<ConfigurationProfileValidator>?>
Set of methods for validating the configuration. Maximum of 2. See validator Block below for more details.
latefinal

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {ConfigurationProfileState? state, CustomResourceOptions? options}) → ConfigurationProfile
Gets an existing ConfigurationProfile resource's state with the given name and id.