/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.appconfig.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateConfigurationProfileRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* The application ID. *
*/ private String applicationId; /** ** A name for the configuration profile. *
*/ private String name; /** ** A description of the configuration profile. *
*/ private String description; /** ** 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).
*
* 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. *
** A list of methods for validating the configuration. *
*/ private java.util.List* 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. *
*/ private java.util.Map
* 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
*
* The application ID. *
* * @param applicationId * The application ID. */ public void setApplicationId(String applicationId) { this.applicationId = applicationId; } /** ** The application ID. *
* * @return The application ID. */ public String getApplicationId() { return this.applicationId; } /** ** The application ID. *
* * @param applicationId * The application ID. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationProfileRequest withApplicationId(String applicationId) { setApplicationId(applicationId); return this; } /** ** A name for the configuration profile. *
* * @param name * A name for the configuration profile. */ public void setName(String name) { this.name = name; } /** ** A name for the configuration profile. *
* * @return A name for the configuration profile. */ public String getName() { return this.name; } /** ** A name for the configuration profile. *
* * @param name * A name for the configuration profile. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationProfileRequest withName(String name) { setName(name); return this; } /** ** A description of the configuration profile. *
* * @param description * A description of the configuration profile. */ public void setDescription(String description) { this.description = description; } /** ** A description of the configuration profile. *
* * @return A description of the configuration profile. */ public String getDescription() { return this.description; } /** ** A description of the configuration profile. *
* * @param description * A description of the configuration profile. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationProfileRequest withDescription(String description) { setDescription(description); return this; } /** ** 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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).
*
* 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. *
*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. *
*/ public void setRetrievalRoleArn(String retrievalRoleArn) { this.retrievalRoleArn = 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. *
*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. *
*/ public String getRetrievalRoleArn() { return this.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. *
*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. *
* @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationProfileRequest withRetrievalRoleArn(String retrievalRoleArn) { setRetrievalRoleArn(retrievalRoleArn); return this; } /** ** A list of methods for validating the configuration. *
* * @return A list of methods for validating the configuration. */ public java.util.List* A list of methods for validating the configuration. *
* * @param validators * A list of methods for validating the configuration. */ public void setValidators(java.util.Collection* A list of methods for validating the configuration. *
** NOTE: This method appends the values to the existing list (if any). Use * {@link #setValidators(java.util.Collection)} or {@link #withValidators(java.util.Collection)} if you want to * override the existing values. *
* * @param validators * A list of methods for validating the configuration. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationProfileRequest withValidators(Validator... validators) { if (this.validators == null) { setValidators(new java.util.ArrayList* A list of methods for validating the configuration. *
* * @param validators * A list of methods for validating the configuration. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationProfileRequest withValidators(java.util.Collection* 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. *
* * @return 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. */ public java.util.Map* 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. *
* * @param 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. */ public void setTags(java.util.Map* 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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateConfigurationProfileRequest withTags(java.util.Map
* 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
*
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
*/
public void setType(String type) {
this.type = 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
*
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
*/
public String getType() {
return this.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
*
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
* @return Returns a reference to this object so that method calls can be chained together.
*/
public CreateConfigurationProfileRequest withType(String type) {
setType(type);
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getApplicationId() != null)
sb.append("ApplicationId: ").append(getApplicationId()).append(",");
if (getName() != null)
sb.append("Name: ").append(getName()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getLocationUri() != null)
sb.append("LocationUri: ").append(getLocationUri()).append(",");
if (getRetrievalRoleArn() != null)
sb.append("RetrievalRoleArn: ").append(getRetrievalRoleArn()).append(",");
if (getValidators() != null)
sb.append("Validators: ").append(getValidators()).append(",");
if (getTags() != null)
sb.append("Tags: ").append(getTags()).append(",");
if (getType() != null)
sb.append("Type: ").append(getType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof CreateConfigurationProfileRequest == false)
return false;
CreateConfigurationProfileRequest other = (CreateConfigurationProfileRequest) obj;
if (other.getApplicationId() == null ^ this.getApplicationId() == null)
return false;
if (other.getApplicationId() != null && other.getApplicationId().equals(this.getApplicationId()) == false)
return false;
if (other.getName() == null ^ this.getName() == null)
return false;
if (other.getName() != null && other.getName().equals(this.getName()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getLocationUri() == null ^ this.getLocationUri() == null)
return false;
if (other.getLocationUri() != null && other.getLocationUri().equals(this.getLocationUri()) == false)
return false;
if (other.getRetrievalRoleArn() == null ^ this.getRetrievalRoleArn() == null)
return false;
if (other.getRetrievalRoleArn() != null && other.getRetrievalRoleArn().equals(this.getRetrievalRoleArn()) == false)
return false;
if (other.getValidators() == null ^ this.getValidators() == null)
return false;
if (other.getValidators() != null && other.getValidators().equals(this.getValidators()) == false)
return false;
if (other.getTags() == null ^ this.getTags() == null)
return false;
if (other.getTags() != null && other.getTags().equals(this.getTags()) == false)
return false;
if (other.getType() == null ^ this.getType() == null)
return false;
if (other.getType() != null && other.getType().equals(this.getType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getApplicationId() == null) ? 0 : getApplicationId().hashCode());
hashCode = prime * hashCode + ((getName() == null) ? 0 : getName().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getLocationUri() == null) ? 0 : getLocationUri().hashCode());
hashCode = prime * hashCode + ((getRetrievalRoleArn() == null) ? 0 : getRetrievalRoleArn().hashCode());
hashCode = prime * hashCode + ((getValidators() == null) ? 0 : getValidators().hashCode());
hashCode = prime * hashCode + ((getTags() == null) ? 0 : getTags().hashCode());
hashCode = prime * hashCode + ((getType() == null) ? 0 : getType().hashCode());
return hashCode;
}
@Override
public CreateConfigurationProfileRequest clone() {
return (CreateConfigurationProfileRequest) super.clone();
}
}