com.amazonaws.services.appconfig.model

Class CreateConfigurationProfileRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.appconfig.model.CreateConfigurationProfileRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateConfigurationProfileRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateConfigurationProfileRequest()

Method Summary

Modifier and Type	Method and Description
CreateConfigurationProfileRequest	addTagsEntry(String key, String value) Add a single Tags entry
CreateConfigurationProfileRequest	clearTagsEntries() Removes all the entries added into Tags.
CreateConfigurationProfileRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getApplicationId() The application ID.
String	getDescription() A description of the configuration profile.
String	getKmsKeyIdentifier() The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store.
String	getLocationUri() A URI to locate the configuration.
String	getName() A name for the configuration profile.
String	getRetrievalRoleArn() The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
Map<String,String>	getTags() Metadata to assign to the configuration profile.
String	getType() The type of configurations contained in the profile.
List<Validator>	getValidators() A list of methods for validating the configuration.
int	hashCode()
void	setApplicationId(String applicationId) The application ID.
void	setDescription(String description) A description of the configuration profile.
void	setKmsKeyIdentifier(String kmsKeyIdentifier) The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store.
void	setLocationUri(String locationUri) A URI to locate the configuration.
void	setName(String name) A name for the configuration profile.
void	setRetrievalRoleArn(String retrievalRoleArn) The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
void	setTags(Map<String,String> tags) Metadata to assign to the configuration profile.
void	setType(String type) The type of configurations contained in the profile.
void	setValidators(Collection<Validator> validators) A list of methods for validating the configuration.
String	toString() Returns a string representation of this object.
CreateConfigurationProfileRequest	withApplicationId(String applicationId) The application ID.
CreateConfigurationProfileRequest	withDescription(String description) A description of the configuration profile.
CreateConfigurationProfileRequest	withKmsKeyIdentifier(String kmsKeyIdentifier) The identifier for an Key Management Service key to encrypt new configuration data versions in the AppConfig hosted configuration store.
CreateConfigurationProfileRequest	withLocationUri(String locationUri) A URI to locate the configuration.
CreateConfigurationProfileRequest	withName(String name) A name for the configuration profile.
CreateConfigurationProfileRequest	withRetrievalRoleArn(String retrievalRoleArn) The ARN of an IAM role with permission to access the configuration at the specified LocationUri.
CreateConfigurationProfileRequest	withTags(Map<String,String> tags) Metadata to assign to the configuration profile.
CreateConfigurationProfileRequest	withType(String type) The type of configurations contained in the profile.
CreateConfigurationProfileRequest	withValidators(Collection<Validator> validators) A list of methods for validating the configuration.
CreateConfigurationProfileRequest	withValidators(Validator... validators) A list of methods for validating the configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateConfigurationProfileRequest

public CreateConfigurationProfileRequest()

Method Detail

setApplicationId

public void setApplicationId(String applicationId)

The application ID.

Parameters:

applicationId - The application ID.

getApplicationId

public String getApplicationId()

The application ID.

Returns:

The application ID.

withApplicationId

public CreateConfigurationProfileRequest withApplicationId(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.

setName

public void setName(String name)

A name for the configuration profile.

Parameters:

name - A name for the configuration profile.

getName

public String getName()

A name for the configuration profile.

Returns:

A name for the configuration profile.

withName

public CreateConfigurationProfileRequest withName(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.

setDescription

public void setDescription(String description)

A description of the configuration profile.

Parameters:

description - A description of the configuration profile.

getDescription

public String getDescription()

A description of the configuration profile.

Returns:

A description of the configuration profile.

withDescription

public CreateConfigurationProfileRequest withDescription(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.

setLocationUri

public void setLocationUri(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).

getLocationUri

public String getLocationUri()

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:

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

withLocationUri

public CreateConfigurationProfileRequest withLocationUri(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.

setRetrievalRoleArn

public void setRetrievalRoleArn(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.

getRetrievalRoleArn

public String getRetrievalRoleArn()

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.

withRetrievalRoleArn

public CreateConfigurationProfileRequest withRetrievalRoleArn(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.

getValidators

public List<Validator> getValidators()

A list of methods for validating the configuration.

Returns:

A list of methods for validating the configuration.

setValidators

public void setValidators(Collection<Validator> validators)

A list of methods for validating the configuration.

Parameters:

validators - A list of methods for validating the configuration.

withValidators

public CreateConfigurationProfileRequest withValidators(Validator... validators)

A list of methods for validating the configuration.

NOTE: This method appends the values to the existing list (if any). Use setValidators(java.util.Collection) or withValidators(java.util.Collection) if you want to override the existing values.

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.

withValidators

public CreateConfigurationProfileRequest withValidators(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.

getTags

public Map<String,String> getTags()

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:

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.

setTags

public void setTags(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.

withTags

public CreateConfigurationProfileRequest withTags(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.

addTagsEntry

public CreateConfigurationProfileRequest addTagsEntry(String key,
                                                      String value)

Add a single Tags entry

See Also:

withTags(java.util.Map<java.lang.String, java.lang.String>)

clearTagsEntries

public CreateConfigurationProfileRequest clearTagsEntries()

Removes all the entries added into Tags.

Returns:

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

setType

public void setType(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

getType

public String getType()

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

withType

public CreateConfigurationProfileRequest withType(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.

setKmsKeyIdentifier

public void setKmsKeyIdentifier(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.

getKmsKeyIdentifier

public String getKmsKeyIdentifier()

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:

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.

withKmsKeyIdentifier

public CreateConfigurationProfileRequest withKmsKeyIdentifier(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.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateConfigurationProfileRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()