com.amazonaws.services.wafv2.model.PutPermissionPolicyRequest 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.wafv2.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 PutPermissionPolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
*
*/
private String resourceArn;
/**
*
* The policy to attach to the specified rule group.
*
*
* The policy specifications must conform to the following:
*
*
* -
*
* The policy must be composed using IAM Policy version 2012-10-17.
*
*
* -
*
* The policy must include specifications for Effect, Action, and Principal.
*
*
* -
*
* Effect must specify Allow.
*
*
* -
*
* Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and
* wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF
* rejects any extra actions or wildcard actions in the policy.
*
*
* -
*
* The policy must not include a Resource parameter.
*
*
*
*
* For more information, see IAM
* Policies.
*
*/
private String policy;
/**
*
* The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
*
*
* @param resourceArn
* The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
*/
public void setResourceArn(String resourceArn) {
this.resourceArn = resourceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
*
*
* @return The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
*/
public String getResourceArn() {
return this.resourceArn;
}
/**
*
* The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
*
*
* @param resourceArn
* The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutPermissionPolicyRequest withResourceArn(String resourceArn) {
setResourceArn(resourceArn);
return this;
}
/**
*
* The policy to attach to the specified rule group.
*
*
* The policy specifications must conform to the following:
*
*
* -
*
* The policy must be composed using IAM Policy version 2012-10-17.
*
*
* -
*
* The policy must include specifications for Effect, Action, and Principal.
*
*
* -
*
* Effect must specify Allow.
*
*
* -
*
* Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and
* wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF
* rejects any extra actions or wildcard actions in the policy.
*
*
* -
*
* The policy must not include a Resource parameter.
*
*
*
*
* For more information, see IAM
* Policies.
*
*
* @param policy
* The policy to attach to the specified rule group.
*
* The policy specifications must conform to the following:
*
*
* -
*
* The policy must be composed using IAM Policy version 2012-10-17.
*
*
* -
*
* The policy must include specifications for Effect, Action, and
* Principal.
*
*
* -
*
* Effect must specify Allow.
*
*
* -
*
* Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and
* wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup
* . WAF rejects any extra actions or wildcard actions in the policy.
*
*
* -
*
* The policy must not include a Resource parameter.
*
*
*
*
* For more information, see IAM Policies.
*/
public void setPolicy(String policy) {
this.policy = policy;
}
/**
*
* The policy to attach to the specified rule group.
*
*
* The policy specifications must conform to the following:
*
*
* -
*
* The policy must be composed using IAM Policy version 2012-10-17.
*
*
* -
*
* The policy must include specifications for Effect, Action, and Principal.
*
*
* -
*
* Effect must specify Allow.
*
*
* -
*
* Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and
* wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF
* rejects any extra actions or wildcard actions in the policy.
*
*
* -
*
* The policy must not include a Resource parameter.
*
*
*
*
* For more information, see IAM
* Policies.
*
*
* @return The policy to attach to the specified rule group.
*
* The policy specifications must conform to the following:
*
*
* -
*
* The policy must be composed using IAM Policy version 2012-10-17.
*
*
* -
*
* The policy must include specifications for Effect, Action, and
* Principal.
*
*
* -
*
* Effect must specify Allow.
*
*
* -
*
* Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and
* wafv2:PutFirewallManagerRuleGroups and may optionally specify
* wafv2:GetRuleGroup. WAF rejects any extra actions or wildcard actions in the policy.
*
*
* -
*
* The policy must not include a Resource parameter.
*
*
*
*
* For more information, see IAM Policies.
*/
public String getPolicy() {
return this.policy;
}
/**
*
* The policy to attach to the specified rule group.
*
*
* The policy specifications must conform to the following:
*
*
* -
*
* The policy must be composed using IAM Policy version 2012-10-17.
*
*
* -
*
* The policy must include specifications for Effect, Action, and Principal.
*
*
* -
*
* Effect must specify Allow.
*
*
* -
*
* Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and
* wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF
* rejects any extra actions or wildcard actions in the policy.
*
*
* -
*
* The policy must not include a Resource parameter.
*
*
*
*
* For more information, see IAM
* Policies.
*
*
* @param policy
* The policy to attach to the specified rule group.
*
* The policy specifications must conform to the following:
*
*
* -
*
* The policy must be composed using IAM Policy version 2012-10-17.
*
*
* -
*
* The policy must include specifications for Effect, Action, and
* Principal.
*
*
* -
*
* Effect must specify Allow.
*
*
* -
*
* Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and
* wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup
* . WAF rejects any extra actions or wildcard actions in the policy.
*
*
* -
*
* The policy must not include a Resource parameter.
*
*
*
*
* For more information, see IAM Policies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutPermissionPolicyRequest withPolicy(String policy) {
setPolicy(policy);
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 (getResourceArn() != null)
sb.append("ResourceArn: ").append(getResourceArn()).append(",");
if (getPolicy() != null)
sb.append("Policy: ").append(getPolicy());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutPermissionPolicyRequest == false)
return false;
PutPermissionPolicyRequest other = (PutPermissionPolicyRequest) obj;
if (other.getResourceArn() == null ^ this.getResourceArn() == null)
return false;
if (other.getResourceArn() != null && other.getResourceArn().equals(this.getResourceArn()) == false)
return false;
if (other.getPolicy() == null ^ this.getPolicy() == null)
return false;
if (other.getPolicy() != null && other.getPolicy().equals(this.getPolicy()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getResourceArn() == null) ? 0 : getResourceArn().hashCode());
hashCode = prime * hashCode + ((getPolicy() == null) ? 0 : getPolicy().hashCode());
return hashCode;
}
@Override
public PutPermissionPolicyRequest clone() {
return (PutPermissionPolicyRequest) super.clone();
}
}