software.amazon.awssdk.services.appconfig.model

Class CreateConfigurationProfileRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.appconfig.model.AppConfigRequest

software.amazon.awssdk.services.appconfig.model.CreateConfigurationProfileRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateConfigurationProfileRequest.Builder,CreateConfigurationProfileRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateConfigurationProfileRequest
extends AppConfigRequest
implements ToCopyableBuilder<CreateConfigurationProfileRequest.Builder,CreateConfigurationProfileRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateConfigurationProfileRequest.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationId() The application ID.
static CreateConfigurationProfileRequest.Builder	builder()
String	description() A description of the configuration profile.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
boolean	hasValidators() For responses, this returns true if the service returned a value for the Validators property.
String	locationUri() A URI to locate the configuration.
String	name() A name for the configuration profile.
String	retrievalRoleArn() The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateConfigurationProfileRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags() Metadata to assign to the configuration profile.
CreateConfigurationProfileRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	type() The type of configurations contained in the profile.
List<Validator>	validators() A list of methods for validating the configuration.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationId

public final String applicationId()

The application ID.

Returns:

The application ID.

name

public final String name()

A name for the configuration profile.

Returns:

A name for the configuration profile.

description

public final String description()

A description of the configuration profile.

Returns:

A description of the configuration profile.

locationUri

public final 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 Secrets Manager secret, specify the URI in the following format: secrets-manager://<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:

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 Secrets Manager secret, specify the URI in the following format: secrets-manager ://<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).

retrievalRoleArn

public final 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.

Returns:

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.

hasValidators

public final boolean hasValidators()

For responses, this returns true if the service returned a value for the Validators property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

validators

public final List<Validator> validators()

A list of methods for validating the configuration.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValidators() method.

Returns:

A list of methods for validating the configuration.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final 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.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

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.

type

public final 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

Returns:

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

toBuilder

public CreateConfigurationProfileRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateConfigurationProfileRequest.Builder,CreateConfigurationProfileRequest>

Specified by:

toBuilder in class AppConfigRequest

builder

public static CreateConfigurationProfileRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateConfigurationProfileRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo