Package software.amazon.awscdk.services.appconfig

Class CfnConfigurationProfile.Builder

java.lang.Object
software.amazon.awscdk.services.appconfig.CfnConfigurationProfile.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnConfigurationProfile>
Enclosing class:
CfnConfigurationProfile
@Stability(Stable) public static final class CfnConfigurationProfile.Builder extends Object implements software.amazon.jsii.Builder<CfnConfigurationProfile>
A fluent builder for CfnConfigurationProfile.

  • Method Details

    • create

      @Stability(Stable) public static CfnConfigurationProfile.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnConfigurationProfile.Builder.

    • applicationId

      @Stability(Stable) public CfnConfigurationProfile.Builder applicationId(String applicationId)
      The application ID.

      Parameters:
      applicationId - The application ID. This parameter is required.
      Returns:
      this

    • locationUri

      @Stability(Stable) public CfnConfigurationProfile.Builder locationUri(String locationUri)
      A URI to locate the configuration. You can specify the following:.

      • For the AWS AppConfig hosted configuration store and for feature flags, specify hosted .
      • For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN.
      • For an AWS CodePipeline pipeline, specify the URI in the following format: codepipeline ://.
      • For an AWS Secrets Manager secret, specify the URI in the following format: secretsmanager ://.
      • 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
      • For an SSM document, specify either the document name in the format ssm-document://<document name> or the Amazon Resource Name (ARN).

      Parameters:
      locationUri - A URI to locate the configuration. You can specify the following:. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnConfigurationProfile.Builder name(String name)
      A name for the configuration profile.

      Parameters:
      name - A name for the configuration profile. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnConfigurationProfile.Builder description(String description)
      A description of the configuration profile.

      Parameters:
      description - A description of the configuration profile. This parameter is required.
      Returns:
      this

    • retrievalRoleArn

      @Stability(Stable) public CfnConfigurationProfile.Builder retrievalRoleArn(String retrievalRoleArn)
      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 AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.

      Parameters:
      retrievalRoleArn - The ARN of an IAM role with permission to access the configuration at the specified LocationUri . This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnConfigurationProfile.Builder tags(List<? extends CfnConfigurationProfile.TagsProperty> tags)
      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.

      Parameters:
      tags - Metadata to assign to the configuration profile. This parameter is required.
      Returns:
      this

    • type

      @Stability(Stable) public CfnConfigurationProfile.Builder type(String type)
      The type of configurations contained in the profile.

      AWS 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

      Parameters:
      type - The type of configurations contained in the profile. This parameter is required.
      Returns:
      this

    • validators

      @Stability(Stable) public CfnConfigurationProfile.Builder validators(IResolvable validators)
      A list of methods for validating the configuration.

      Parameters:
      validators - A list of methods for validating the configuration. This parameter is required.
      Returns:
      this

    • validators

      @Stability(Stable) public CfnConfigurationProfile.Builder validators(List<? extends Object> validators)
      A list of methods for validating the configuration.

      Parameters:
      validators - A list of methods for validating the configuration. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnConfigurationProfile build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnConfigurationProfile>
      Returns:
      a newly built instance of CfnConfigurationProfile.