com.amazonaws.services.accessanalyzer.model.ValidatePolicyRequest Maven / Gradle / Ivy
/*
* 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.accessanalyzer.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 ValidatePolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The locale to use for localizing the findings.
*
*/
private String locale;
/**
*
* The maximum number of results to return in the response.
*
*/
private Integer maxResults;
/**
*
* A token used for pagination of results returned.
*
*/
private String nextToken;
/**
*
* The JSON policy document to use as the content for the policy.
*
*/
private String policyDocument;
/**
*
* The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include
* managed and inline policies for IAM roles, users, and groups. They also include service-control policies (SCPs)
* that are attached to an Amazon Web Services organization, organizational unit (OU), or an account.
*
*
* Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies
* for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy
* or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
*
*/
private String policyType;
/**
*
* The type of resource to attach to your resource policy. Specify a value for the policy validation resource type
* only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to
* an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.
*
*
* For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all
* resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for
* the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource
* policies.
*
*/
private String validatePolicyResourceType;
/**
*
* The locale to use for localizing the findings.
*
*
* @param locale
* The locale to use for localizing the findings.
* @see Locale
*/
public void setLocale(String locale) {
this.locale = locale;
}
/**
*
* The locale to use for localizing the findings.
*
*
* @return The locale to use for localizing the findings.
* @see Locale
*/
public String getLocale() {
return this.locale;
}
/**
*
* The locale to use for localizing the findings.
*
*
* @param locale
* The locale to use for localizing the findings.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Locale
*/
public ValidatePolicyRequest withLocale(String locale) {
setLocale(locale);
return this;
}
/**
*
* The locale to use for localizing the findings.
*
*
* @param locale
* The locale to use for localizing the findings.
* @return Returns a reference to this object so that method calls can be chained together.
* @see Locale
*/
public ValidatePolicyRequest withLocale(Locale locale) {
this.locale = locale.toString();
return this;
}
/**
*
* The maximum number of results to return in the response.
*
*
* @param maxResults
* The maximum number of results to return in the response.
*/
public void setMaxResults(Integer maxResults) {
this.maxResults = maxResults;
}
/**
*
* The maximum number of results to return in the response.
*
*
* @return The maximum number of results to return in the response.
*/
public Integer getMaxResults() {
return this.maxResults;
}
/**
*
* The maximum number of results to return in the response.
*
*
* @param maxResults
* The maximum number of results to return in the response.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ValidatePolicyRequest withMaxResults(Integer maxResults) {
setMaxResults(maxResults);
return this;
}
/**
*
* A token used for pagination of results returned.
*
*
* @param nextToken
* A token used for pagination of results returned.
*/
public void setNextToken(String nextToken) {
this.nextToken = nextToken;
}
/**
*
* A token used for pagination of results returned.
*
*
* @return A token used for pagination of results returned.
*/
public String getNextToken() {
return this.nextToken;
}
/**
*
* A token used for pagination of results returned.
*
*
* @param nextToken
* A token used for pagination of results returned.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ValidatePolicyRequest withNextToken(String nextToken) {
setNextToken(nextToken);
return this;
}
/**
*
* The JSON policy document to use as the content for the policy.
*
*
* @param policyDocument
* The JSON policy document to use as the content for the policy.
*/
public void setPolicyDocument(String policyDocument) {
this.policyDocument = policyDocument;
}
/**
*
* The JSON policy document to use as the content for the policy.
*
*
* @return The JSON policy document to use as the content for the policy.
*/
public String getPolicyDocument() {
return this.policyDocument;
}
/**
*
* The JSON policy document to use as the content for the policy.
*
*
* @param policyDocument
* The JSON policy document to use as the content for the policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public ValidatePolicyRequest withPolicyDocument(String policyDocument) {
setPolicyDocument(policyDocument);
return this;
}
/**
*
* The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include
* managed and inline policies for IAM roles, users, and groups. They also include service-control policies (SCPs)
* that are attached to an Amazon Web Services organization, organizational unit (OU), or an account.
*
*
* Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies
* for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy
* or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
*
*
* @param policyType
* The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies
* include managed and inline policies for IAM roles, users, and groups. They also include service-control
* policies (SCPs) that are attached to an Amazon Web Services organization, organizational unit (OU), or an
* account.
*
* Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust
* policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as
* identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
* @see PolicyType
*/
public void setPolicyType(String policyType) {
this.policyType = policyType;
}
/**
*
* The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include
* managed and inline policies for IAM roles, users, and groups. They also include service-control policies (SCPs)
* that are attached to an Amazon Web Services organization, organizational unit (OU), or an account.
*
*
* Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies
* for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy
* or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
*
*
* @return The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies
* include managed and inline policies for IAM roles, users, and groups. They also include service-control
* policies (SCPs) that are attached to an Amazon Web Services organization, organizational unit (OU), or an
* account.
*
* Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust
* policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as
* identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
* @see PolicyType
*/
public String getPolicyType() {
return this.policyType;
}
/**
*
* The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include
* managed and inline policies for IAM roles, users, and groups. They also include service-control policies (SCPs)
* that are attached to an Amazon Web Services organization, organizational unit (OU), or an account.
*
*
* Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies
* for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy
* or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
*
*
* @param policyType
* The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies
* include managed and inline policies for IAM roles, users, and groups. They also include service-control
* policies (SCPs) that are attached to an Amazon Web Services organization, organizational unit (OU), or an
* account.
*
* Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust
* policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as
* identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyType
*/
public ValidatePolicyRequest withPolicyType(String policyType) {
setPolicyType(policyType);
return this;
}
/**
*
* The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies include
* managed and inline policies for IAM roles, users, and groups. They also include service-control policies (SCPs)
* that are attached to an Amazon Web Services organization, organizational unit (OU), or an account.
*
*
* Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust policies
* for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as identity policy
* or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
*
*
* @param policyType
* The type of policy to validate. Identity policies grant permissions to IAM principals. Identity policies
* include managed and inline policies for IAM roles, users, and groups. They also include service-control
* policies (SCPs) that are attached to an Amazon Web Services organization, organizational unit (OU), or an
* account.
*
* Resource policies grant permissions on Amazon Web Services resources. Resource policies include trust
* policies for IAM roles and bucket policies for Amazon S3 buckets. You can provide a generic input such as
* identity policy or resource policy or a specific input such as managed policy or Amazon S3 bucket policy.
* @return Returns a reference to this object so that method calls can be chained together.
* @see PolicyType
*/
public ValidatePolicyRequest withPolicyType(PolicyType policyType) {
this.policyType = policyType.toString();
return this;
}
/**
*
* The type of resource to attach to your resource policy. Specify a value for the policy validation resource type
* only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to
* an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.
*
*
* For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all
* resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for
* the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource
* policies.
*
*
* @param validatePolicyResourceType
* The type of resource to attach to your resource policy. Specify a value for the policy validation resource
* type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy
* to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation
* resource type.
*
* For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all
* resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a
* value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to
* all resource policies.
* @see ValidatePolicyResourceType
*/
public void setValidatePolicyResourceType(String validatePolicyResourceType) {
this.validatePolicyResourceType = validatePolicyResourceType;
}
/**
*
* The type of resource to attach to your resource policy. Specify a value for the policy validation resource type
* only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to
* an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.
*
*
* For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all
* resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for
* the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource
* policies.
*
*
* @return The type of resource to attach to your resource policy. Specify a value for the policy validation
* resource type only if the policy type is RESOURCE_POLICY. For example, to validate a
* resource policy to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the
* policy validation resource type.
*
* For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to
* all resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify
* a value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply
* to all resource policies.
* @see ValidatePolicyResourceType
*/
public String getValidatePolicyResourceType() {
return this.validatePolicyResourceType;
}
/**
*
* The type of resource to attach to your resource policy. Specify a value for the policy validation resource type
* only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to
* an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.
*
*
* For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all
* resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for
* the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource
* policies.
*
*
* @param validatePolicyResourceType
* The type of resource to attach to your resource policy. Specify a value for the policy validation resource
* type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy
* to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation
* resource type.
*
* For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all
* resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a
* value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to
* all resource policies.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ValidatePolicyResourceType
*/
public ValidatePolicyRequest withValidatePolicyResourceType(String validatePolicyResourceType) {
setValidatePolicyResourceType(validatePolicyResourceType);
return this;
}
/**
*
* The type of resource to attach to your resource policy. Specify a value for the policy validation resource type
* only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy to attach to
* an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation resource type.
*
*
* For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all
* resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a value for
* the policy validation resource type and IAM Access Analyzer will run policy checks that apply to all resource
* policies.
*
*
* @param validatePolicyResourceType
* The type of resource to attach to your resource policy. Specify a value for the policy validation resource
* type only if the policy type is RESOURCE_POLICY. For example, to validate a resource policy
* to attach to an Amazon S3 bucket, you can choose AWS::S3::Bucket for the policy validation
* resource type.
*
* For resource types not supported as valid values, IAM Access Analyzer runs policy checks that apply to all
* resource policies. For example, to validate a resource policy to attach to a KMS key, do not specify a
* value for the policy validation resource type and IAM Access Analyzer will run policy checks that apply to
* all resource policies.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ValidatePolicyResourceType
*/
public ValidatePolicyRequest withValidatePolicyResourceType(ValidatePolicyResourceType validatePolicyResourceType) {
this.validatePolicyResourceType = validatePolicyResourceType.toString();
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 (getLocale() != null)
sb.append("Locale: ").append(getLocale()).append(",");
if (getMaxResults() != null)
sb.append("MaxResults: ").append(getMaxResults()).append(",");
if (getNextToken() != null)
sb.append("NextToken: ").append(getNextToken()).append(",");
if (getPolicyDocument() != null)
sb.append("PolicyDocument: ").append(getPolicyDocument()).append(",");
if (getPolicyType() != null)
sb.append("PolicyType: ").append(getPolicyType()).append(",");
if (getValidatePolicyResourceType() != null)
sb.append("ValidatePolicyResourceType: ").append(getValidatePolicyResourceType());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof ValidatePolicyRequest == false)
return false;
ValidatePolicyRequest other = (ValidatePolicyRequest) obj;
if (other.getLocale() == null ^ this.getLocale() == null)
return false;
if (other.getLocale() != null && other.getLocale().equals(this.getLocale()) == false)
return false;
if (other.getMaxResults() == null ^ this.getMaxResults() == null)
return false;
if (other.getMaxResults() != null && other.getMaxResults().equals(this.getMaxResults()) == false)
return false;
if (other.getNextToken() == null ^ this.getNextToken() == null)
return false;
if (other.getNextToken() != null && other.getNextToken().equals(this.getNextToken()) == false)
return false;
if (other.getPolicyDocument() == null ^ this.getPolicyDocument() == null)
return false;
if (other.getPolicyDocument() != null && other.getPolicyDocument().equals(this.getPolicyDocument()) == false)
return false;
if (other.getPolicyType() == null ^ this.getPolicyType() == null)
return false;
if (other.getPolicyType() != null && other.getPolicyType().equals(this.getPolicyType()) == false)
return false;
if (other.getValidatePolicyResourceType() == null ^ this.getValidatePolicyResourceType() == null)
return false;
if (other.getValidatePolicyResourceType() != null && other.getValidatePolicyResourceType().equals(this.getValidatePolicyResourceType()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getLocale() == null) ? 0 : getLocale().hashCode());
hashCode = prime * hashCode + ((getMaxResults() == null) ? 0 : getMaxResults().hashCode());
hashCode = prime * hashCode + ((getNextToken() == null) ? 0 : getNextToken().hashCode());
hashCode = prime * hashCode + ((getPolicyDocument() == null) ? 0 : getPolicyDocument().hashCode());
hashCode = prime * hashCode + ((getPolicyType() == null) ? 0 : getPolicyType().hashCode());
hashCode = prime * hashCode + ((getValidatePolicyResourceType() == null) ? 0 : getValidatePolicyResourceType().hashCode());
return hashCode;
}
@Override
public ValidatePolicyRequest clone() {
return (ValidatePolicyRequest) super.clone();
}
}