software.amazon.awssdk.services.iam.model.CreatePolicyRequest Maven / Gradle / Ivy
/*
* Copyright 2014-2019 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 software.amazon.awssdk.services.iam.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreatePolicyRequest extends IamRequest implements
ToCopyableBuilder {
private static final SdkField POLICY_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreatePolicyRequest::policyName)).setter(setter(Builder::policyName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyName").build()).build();
private static final SdkField PATH_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreatePolicyRequest::path)).setter(setter(Builder::path))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Path").build()).build();
private static final SdkField POLICY_DOCUMENT_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreatePolicyRequest::policyDocument)).setter(setter(Builder::policyDocument))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("PolicyDocument").build()).build();
private static final SdkField DESCRIPTION_FIELD = SdkField. builder(MarshallingType.STRING)
.getter(getter(CreatePolicyRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(POLICY_NAME_FIELD, PATH_FIELD,
POLICY_DOCUMENT_FIELD, DESCRIPTION_FIELD));
private final String policyName;
private final String path;
private final String policyDocument;
private final String description;
private CreatePolicyRequest(BuilderImpl builder) {
super(builder);
this.policyName = builder.policyName;
this.path = builder.path;
this.policyDocument = builder.policyDocument;
this.description = builder.description;
}
/**
*
* The friendly name of the policy.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of
* the following characters: _+=,.@-
*
*
* @return The friendly name of the policy.
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also
* include any of the following characters: _+=,.@-
*/
public String policyName() {
return policyName;
}
/**
*
* The path for the policy.
*
*
* For more information about paths, see IAM Identifiers in the IAM
* User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward
* slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL character (\u007F),
* including most punctuation characters, digits, and upper and lowercased letters.
*
*
* @return The path for the policy.
*
* For more information about paths, see IAM Identifiers in the
* IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a string
* of characters consisting of either a forward slash (/) by itself or a string that must begin and end with
* forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL
* character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
*/
public String path() {
return path;
}
/**
*
* The JSON policy document that you want to use as the content for the new policy.
*
*
* The regex pattern used to validate this parameter is a string of
* characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
*
*
* -
*
* The special characters tab ( ), line feed ( ), and carriage return ( )
*
*
*
*
* @return The JSON policy document that you want to use as the content for the new policy.
*
* The regex pattern used to validate this parameter is a
* string of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character
* range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
*
*
* -
*
* The special characters tab ( ), line feed ( ), and carriage return ( )
*
*
*/
public String policyDocument() {
return policyDocument;
}
/**
*
* A friendly description of the policy.
*
*
* Typically used to store information about the permissions defined in the policy. For example,
* "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it cannot be changed.
*
*
* @return A friendly description of the policy.
*
* Typically used to store information about the permissions defined in the policy. For example,
* "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it cannot be changed.
*/
public String description() {
return description;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(policyName());
hashCode = 31 * hashCode + Objects.hashCode(path());
hashCode = 31 * hashCode + Objects.hashCode(policyDocument());
hashCode = 31 * hashCode + Objects.hashCode(description());
return hashCode;
}
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreatePolicyRequest)) {
return false;
}
CreatePolicyRequest other = (CreatePolicyRequest) obj;
return Objects.equals(policyName(), other.policyName()) && Objects.equals(path(), other.path())
&& Objects.equals(policyDocument(), other.policyDocument()) && Objects.equals(description(), other.description());
}
@Override
public String toString() {
return ToString.builder("CreatePolicyRequest").add("PolicyName", policyName()).add("Path", path())
.add("PolicyDocument", policyDocument()).add("Description", description()).build();
}
public Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "PolicyName":
return Optional.ofNullable(clazz.cast(policyName()));
case "Path":
return Optional.ofNullable(clazz.cast(path()));
case "PolicyDocument":
return Optional.ofNullable(clazz.cast(policyDocument()));
case "Description":
return Optional.ofNullable(clazz.cast(description()));
default:
return Optional.empty();
}
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreatePolicyRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends IamRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* The friendly name of the policy.
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any
* of the following characters: _+=,.@-
*
*
* @param policyName
* The friendly name of the policy.
*
* This parameter allows (through its regex pattern) a
* string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can
* also include any of the following characters: _+=,.@-
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyName(String policyName);
/**
*
* The path for the policy.
*
*
* For more information about paths, see IAM Identifiers in the
* IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a string of
* characters consisting of either a forward slash (/) by itself or a string that must begin and end with
* forward slashes. In addition, it can contain any ASCII character from the ! (\u0021) through the DEL
* character (\u007F), including most punctuation characters, digits, and upper and lowercased letters.
*
*
* @param path
* The path for the policy.
*
* For more information about paths, see IAM Identifiers in
* the IAM User Guide.
*
*
* This parameter is optional. If it is not included, it defaults to a slash (/).
*
*
* This parameter allows (through its regex pattern) a
* string of characters consisting of either a forward slash (/) by itself or a string that must begin
* and end with forward slashes. In addition, it can contain any ASCII character from the ! (\u0021)
* through the DEL character (\u007F), including most punctuation characters, digits, and upper and
* lowercased letters.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder path(String path);
/**
*
* The JSON policy document that you want to use as the content for the new policy.
*
*
* The regex pattern used to validate this parameter is a string
* of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character
* range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
*
*
* -
*
* The special characters tab ( ), line feed ( ), and carriage return ( )
*
*
*
*
* @param policyDocument
* The JSON policy document that you want to use as the content for the new policy.
*
* The regex pattern used to validate this parameter is a
* string of characters consisting of the following:
*
*
* -
*
* Any printable ASCII character ranging from the space character ( ) through the end of the ASCII
* character range
*
*
* -
*
* The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)
*
*
* -
*
* The special characters tab ( ), line feed ( ), and carriage return ( )
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder policyDocument(String policyDocument);
/**
*
* A friendly description of the policy.
*
*
* Typically used to store information about the permissions defined in the policy. For example,
* "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it cannot be changed.
*
*
* @param description
* A friendly description of the policy.
*
* Typically used to store information about the permissions defined in the policy. For example,
* "Grants access to production DynamoDB tables."
*
*
* The policy description is immutable. After a value is assigned, it cannot be changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder description(String description);
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends IamRequest.BuilderImpl implements Builder {
private String policyName;
private String path;
private String policyDocument;
private String description;
private BuilderImpl() {
}
private BuilderImpl(CreatePolicyRequest model) {
super(model);
policyName(model.policyName);
path(model.path);
policyDocument(model.policyDocument);
description(model.description);
}
public final String getPolicyName() {
return policyName;
}
@Override
public final Builder policyName(String policyName) {
this.policyName = policyName;
return this;
}
public final void setPolicyName(String policyName) {
this.policyName = policyName;
}
public final String getPath() {
return path;
}
@Override
public final Builder path(String path) {
this.path = path;
return this;
}
public final void setPath(String path) {
this.path = path;
}
public final String getPolicyDocument() {
return policyDocument;
}
@Override
public final Builder policyDocument(String policyDocument) {
this.policyDocument = policyDocument;
return this;
}
public final void setPolicyDocument(String policyDocument) {
this.policyDocument = policyDocument;
}
public final String getDescription() {
return description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreatePolicyRequest build() {
return new CreatePolicyRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}