Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Native
  3. API Docs
  4. appconfig
  5. ConfigurationProfile

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.appconfig.ConfigurationProfile

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
pulumi/pulumi-aws-native

    An example resource schema demonstrating some basic constructs and validation rules.

    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[Sequence[_root_inputs.TagArgs]] = None,
                         type: Optional[str] = None,
                         validators: Optional[Sequence[ConfigurationProfileValidatorsArgs]] = 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-native: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.

    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
    The application ID.
    LocationUri string
    A 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.
    Description string
    A description of the configuration profile.
    KmsKeyIdentifier string
    The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
    Name string
    A name for the configuration profile.
    RetrievalRoleArn string
    The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
    Type string
    The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
    Validators List<Pulumi.AwsNative.AppConfig.Inputs.ConfigurationProfileValidators>
    A list of methods for validating the configuration.
    ApplicationId string
    The application ID.
    LocationUri string
    A 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.
    Description string
    A description of the configuration profile.
    KmsKeyIdentifier string
    The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
    Name string
    A name for the configuration profile.
    RetrievalRoleArn string
    The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    Tags TagArgs
    Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
    Type string
    The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
    Validators []ConfigurationProfileValidatorsArgs
    A list of methods for validating the configuration.
    applicationId String
    The application ID.
    locationUri String
    A 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.
    description String
    A description of the configuration profile.
    kmsKeyIdentifier String
    The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
    name String
    A name for the configuration profile.
    retrievalRoleArn String
    The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    tags List<Tag>
    Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
    type String
    The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
    validators List<ConfigurationProfileValidators>
    A list of methods for validating the configuration.
    applicationId string
    The application ID.
    locationUri string
    A 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.
    description string
    A description of the configuration profile.
    kmsKeyIdentifier string
    The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
    name string
    A name for the configuration profile.
    retrievalRoleArn string
    The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    tags Tag[]
    Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
    type string
    The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
    validators ConfigurationProfileValidators[]
    A list of methods for validating the configuration.
    application_id str
    The application ID.
    location_uri str
    A 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.
    description str
    A description of the configuration profile.
    kms_key_identifier str
    The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
    name str
    A name for the configuration profile.
    retrieval_role_arn str
    The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    tags Sequence[TagArgs]
    Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
    type str
    The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
    validators Sequence[ConfigurationProfileValidatorsArgs]
    A list of methods for validating the configuration.
    applicationId String
    The application ID.
    locationUri String
    A 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.
    description String
    A description of the configuration profile.
    kmsKeyIdentifier String
    The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
    name String
    A name for the configuration profile.
    retrievalRoleArn String
    The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
    tags List<Property Map>
    Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
    type String
    The type of configurations contained in the profile. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags, AWS.Freeform
    validators List<Property Map>
    A list of methods for validating the configuration.

    Outputs

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

    ConfigurationProfileId string
    The configuration profile ID
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyArn string
    The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
    ConfigurationProfileId string
    The configuration profile ID
    Id string
    The provider-assigned unique ID for this managed resource.
    KmsKeyArn string
    The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
    configurationProfileId String
    The configuration profile ID
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyArn String
    The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
    configurationProfileId string
    The configuration profile ID
    id string
    The provider-assigned unique ID for this managed resource.
    kmsKeyArn string
    The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
    configuration_profile_id str
    The configuration profile ID
    id str
    The provider-assigned unique ID for this managed resource.
    kms_key_arn str
    The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.
    configurationProfileId String
    The configuration profile ID
    id String
    The provider-assigned unique ID for this managed resource.
    kmsKeyArn String
    The Amazon Resource Name of the AWS Key Management Service key to encrypt new configuration data versions in the AWS AppConfig hosted configuration store. This attribute is only used for hosted configuration types. To encrypt data managed in other configuration stores, see the documentation for how to specify an AWS KMS key for that particular service.

    Supporting Types

    ConfigurationProfileValidators, ConfigurationProfileValidatorsArgs

    Content string
    Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
    Type string
    AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.
    Content string
    Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
    Type string
    AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.
    content String
    Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
    type String
    AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.
    content string
    Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
    type string
    AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.
    content str
    Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
    type str
    AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.
    content String
    Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function.
    type String
    AWS AppConfig supports validators of type JSON_SCHEMA and LAMBDA.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi
    pulumi/pulumi-aws-native