com.amazonaws.services.cloudformation.model.GetTemplateSummaryRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* 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.cloudformation.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The input for the GetTemplateSummary action.
*
*
* @see AWS
* API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetTemplateSummaryRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
* more information about templates, see Template anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*/
private String templateBody;
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's
* located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*/
private String templateURL;
/**
*
* The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running
* stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the
* unique stack ID.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*/
private String stackName;
/**
*
* The name or unique ID of the stack set from which the stack was created.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*/
private String stackSetName;
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*/
private String callAs;
/**
*
* Specifies options for the GetTemplateSummary API action.
*
*/
private TemplateSummaryConfig templateSummaryConfig;
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
* more information about templates, see Template anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param templateBody
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
* bytes. For more information about templates, see Template
* anatomy in the CloudFormation User Guide.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public void setTemplateBody(String templateBody) {
this.templateBody = templateBody;
}
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
* more information about templates, see Template anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @return Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
* bytes. For more information about templates, see Template
* anatomy in the CloudFormation User Guide.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public String getTemplateBody() {
return this.templateBody;
}
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes. For
* more information about templates, see Template anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param templateBody
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
* bytes. For more information about templates, see Template
* anatomy in the CloudFormation User Guide.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemplateSummaryRequest withTemplateBody(String templateBody) {
setTemplateBody(templateBody);
return this;
}
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's
* located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param templateURL
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes)
* that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates,
* see Template
* anatomy in the CloudFormation User Guide.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public void setTemplateURL(String templateURL) {
this.templateURL = templateURL;
}
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's
* located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @return Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes)
* that's located in an Amazon S3 bucket or a Systems Manager document. For more information about
* templates, see Template
* anatomy in the CloudFormation User Guide.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public String getTemplateURL() {
return this.templateURL;
}
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's
* located in an Amazon S3 bucket or a Systems Manager document. For more information about templates, see Template anatomy
* in the CloudFormation User Guide.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param templateURL
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes)
* that's located in an Amazon S3 bucket or a Systems Manager document. For more information about templates,
* see Template
* anatomy in the CloudFormation User Guide.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemplateSummaryRequest withTemplateURL(String templateURL) {
setTemplateURL(templateURL);
return this;
}
/**
*
* The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running
* stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the
* unique stack ID.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param stackName
* The name or the stack ID that's associated with the stack, which aren't always interchangeable. For
* running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you
* must specify the unique stack ID.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public void setStackName(String stackName) {
this.stackName = stackName;
}
/**
*
* The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running
* stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the
* unique stack ID.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @return The name or the stack ID that's associated with the stack, which aren't always interchangeable. For
* running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you
* must specify the unique stack ID.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public String getStackName() {
return this.stackName;
}
/**
*
* The name or the stack ID that's associated with the stack, which aren't always interchangeable. For running
* stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you must specify the
* unique stack ID.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param stackName
* The name or the stack ID that's associated with the stack, which aren't always interchangeable. For
* running stacks, you can specify either the stack's name or its unique stack ID. For deleted stack, you
* must specify the unique stack ID.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemplateSummaryRequest withStackName(String stackName) {
setStackName(stackName);
return this;
}
/**
*
* The name or unique ID of the stack set from which the stack was created.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param stackSetName
* The name or unique ID of the stack set from which the stack was created.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public void setStackSetName(String stackSetName) {
this.stackSetName = stackSetName;
}
/**
*
* The name or unique ID of the stack set from which the stack was created.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @return The name or unique ID of the stack set from which the stack was created.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public String getStackSetName() {
return this.stackSetName;
}
/**
*
* The name or unique ID of the stack set from which the stack was created.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param stackSetName
* The name or unique ID of the stack set from which the stack was created.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemplateSummaryRequest withStackSetName(String stackSetName) {
setStackSetName(stackSetName);
return this;
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @param callAs
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @see CallAs
*/
public void setCallAs(String callAs) {
this.callAs = callAs;
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @return [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @see CallAs
*/
public String getCallAs() {
return this.callAs;
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @param callAs
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CallAs
*/
public GetTemplateSummaryRequest withCallAs(String callAs) {
setCallAs(callAs);
return this;
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @param callAs
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see CallAs
*/
public GetTemplateSummaryRequest withCallAs(CallAs callAs) {
this.callAs = callAs.toString();
return this;
}
/**
*
* Specifies options for the GetTemplateSummary API action.
*
*
* @param templateSummaryConfig
* Specifies options for the GetTemplateSummary API action.
*/
public void setTemplateSummaryConfig(TemplateSummaryConfig templateSummaryConfig) {
this.templateSummaryConfig = templateSummaryConfig;
}
/**
*
* Specifies options for the GetTemplateSummary API action.
*
*
* @return Specifies options for the GetTemplateSummary API action.
*/
public TemplateSummaryConfig getTemplateSummaryConfig() {
return this.templateSummaryConfig;
}
/**
*
* Specifies options for the GetTemplateSummary API action.
*
*
* @param templateSummaryConfig
* Specifies options for the GetTemplateSummary API action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemplateSummaryRequest withTemplateSummaryConfig(TemplateSummaryConfig templateSummaryConfig) {
setTemplateSummaryConfig(templateSummaryConfig);
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 (getTemplateBody() != null)
sb.append("TemplateBody: ").append(getTemplateBody()).append(",");
if (getTemplateURL() != null)
sb.append("TemplateURL: ").append(getTemplateURL()).append(",");
if (getStackName() != null)
sb.append("StackName: ").append(getStackName()).append(",");
if (getStackSetName() != null)
sb.append("StackSetName: ").append(getStackSetName()).append(",");
if (getCallAs() != null)
sb.append("CallAs: ").append(getCallAs()).append(",");
if (getTemplateSummaryConfig() != null)
sb.append("TemplateSummaryConfig: ").append(getTemplateSummaryConfig());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetTemplateSummaryRequest == false)
return false;
GetTemplateSummaryRequest other = (GetTemplateSummaryRequest) obj;
if (other.getTemplateBody() == null ^ this.getTemplateBody() == null)
return false;
if (other.getTemplateBody() != null && other.getTemplateBody().equals(this.getTemplateBody()) == false)
return false;
if (other.getTemplateURL() == null ^ this.getTemplateURL() == null)
return false;
if (other.getTemplateURL() != null && other.getTemplateURL().equals(this.getTemplateURL()) == false)
return false;
if (other.getStackName() == null ^ this.getStackName() == null)
return false;
if (other.getStackName() != null && other.getStackName().equals(this.getStackName()) == false)
return false;
if (other.getStackSetName() == null ^ this.getStackSetName() == null)
return false;
if (other.getStackSetName() != null && other.getStackSetName().equals(this.getStackSetName()) == false)
return false;
if (other.getCallAs() == null ^ this.getCallAs() == null)
return false;
if (other.getCallAs() != null && other.getCallAs().equals(this.getCallAs()) == false)
return false;
if (other.getTemplateSummaryConfig() == null ^ this.getTemplateSummaryConfig() == null)
return false;
if (other.getTemplateSummaryConfig() != null && other.getTemplateSummaryConfig().equals(this.getTemplateSummaryConfig()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getTemplateBody() == null) ? 0 : getTemplateBody().hashCode());
hashCode = prime * hashCode + ((getTemplateURL() == null) ? 0 : getTemplateURL().hashCode());
hashCode = prime * hashCode + ((getStackName() == null) ? 0 : getStackName().hashCode());
hashCode = prime * hashCode + ((getStackSetName() == null) ? 0 : getStackSetName().hashCode());
hashCode = prime * hashCode + ((getCallAs() == null) ? 0 : getCallAs().hashCode());
hashCode = prime * hashCode + ((getTemplateSummaryConfig() == null) ? 0 : getTemplateSummaryConfig().hashCode());
return hashCode;
}
@Override
public GetTemplateSummaryRequest clone() {
return (GetTemplateSummaryRequest) super.clone();
}
}