Package software.amazon.awssdk.services.appconfig.model

Interface CreateConfigurationProfileRequest.Builder

    • Method Detail

      • applicationId

        CreateConfigurationProfileRequest.Builder applicationId​(String applicationId)

        The application ID.

        Parameters:
        applicationId - The application ID.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • name

        CreateConfigurationProfileRequest.Builder name​(String name)

        A name for the configuration profile.

        Parameters:
        name - A name for the configuration profile.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CreateConfigurationProfileRequest.Builder description​(String description)

        A description of the configuration profile.

        Parameters:
        description - A description of the configuration profile.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • locationUri

        CreateConfigurationProfileRequest.Builder locationUri​(String locationUri)

        A URI to locate the configuration. You can specify the following:

        • For the AppConfig hosted configuration store and for feature flags, specify hosted.

        • For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN.

        • For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format: codepipeline://<pipeline name>.

        • For an Secrets Manager secret, specify the URI in the following format: secretsmanager ://<secret name>.

        • 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:

        • For the AppConfig hosted configuration store and for feature flags, specify hosted.

        • For an Amazon Web Services Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN.

        • For an Amazon Web Services CodePipeline pipeline, specify the URI in the following format: codepipeline://<pipeline name>.

        • For an Secrets Manager secret, specify the URI in the following format: secretsmanager ://<secret name>.

        • 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).

        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • retrievalRoleArn

        CreateConfigurationProfileRequest.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 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.

        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:
        Returns a reference to this object so that method calls can be chained together.

      • validators

        CreateConfigurationProfileRequest.Builder validators​(Collection<Validator> validators)

        A list of methods for validating the configuration.

        Parameters:
        validators - A list of methods for validating the configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • validators

        CreateConfigurationProfileRequest.Builder validators​(Validator... validators)

        A list of methods for validating the configuration.

        Parameters:
        validators - A list of methods for validating the configuration.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateConfigurationProfileRequest.Builder tags​(Map<String,​String> tags)

        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.

        Parameters:
        tags - 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:
        Returns a reference to this object so that method calls can be chained together.

      • type

        CreateConfigurationProfileRequest.Builder type​(String type)

        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

        Parameters:
        type - 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:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyIdentifier

        CreateConfigurationProfileRequest.Builder kmsKeyIdentifier​(String kmsKeyIdentifier)

        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. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.

        Parameters:
        kmsKeyIdentifier - 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. To encrypt data managed in other configuration stores, see the documentation for how to specify an KMS key for that particular service.
        Returns:
        Returns a reference to this object so that method calls can be chained together.