software.amazon.awssdk.services.iam.model.CreatePolicyRequest Maven / Gradle / Ivy
Show all versions of iam Show documentation
/*
* Copyright 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.Collection;
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 java.util.stream.Collectors;
import java.util.stream.Stream;
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.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
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)
.memberName("PolicyName").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).memberName("Path")
.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)
.memberName("PolicyDocument").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)
.memberName("Description").getter(getter(CreatePolicyRequest::description)).setter(setter(Builder::description))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Description").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("Tags")
.getter(getter(CreatePolicyRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("Tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(POLICY_NAME_FIELD, PATH_FIELD,
POLICY_DOCUMENT_FIELD, DESCRIPTION_FIELD, TAGS_FIELD));
private final String policyName;
private final String path;
private final String policyDocument;
private final String description;
private final List tags;
private CreatePolicyRequest(BuilderImpl builder) {
super(builder);
this.policyName = builder.policyName;
this.path = builder.path;
this.policyDocument = builder.policyDocument;
this.description = builder.description;
this.tags = builder.tags;
}
/**
*
* The friendly name of the policy.
*
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by case.
* For example, you cannot create resources named both "MyResource" and "myresource".
*
*
* @return The friendly name of the policy.
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by
* case. For example, you cannot create resources named both "MyResource" and "myresource".
*/
public final 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.
*
*
*
* You cannot use an asterisk (*) in the path name.
*
*
*
* @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.
*
*
*
* You cannot use an asterisk (*) in the path name.
*
*/
public final String path() {
return path;
}
/**
*
* The JSON policy document that you want to use as the content for the new policy.
*
*
* You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can
* provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before
* submitting it to IAM.
*
*
* The maximum length of the policy document that you can pass in this operation, including whitespace, is listed
* below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
*
*
* To learn more about JSON policy grammar, see Grammar of the IAM JSON
* policy language in the IAM User Guide.
*
*
* 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 (\u0020) 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 (\u0009), line feed (\u000A), and carriage return (\u000D
* )
*
*
*
*
* @return The JSON policy document that you want to use as the content for the new policy.
*
* You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML,
* you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON
* format before submitting it to IAM.
*
*
* The maximum length of the policy document that you can pass in this operation, including whitespace, is
* listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
*
*
* To learn more about JSON policy grammar, see Grammar of the
* IAM JSON policy language in the IAM User Guide.
*
*
* 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 (\u0020) 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 (\u0009), line feed (\u000A), and carriage return (
* \u000D)
*
*
*/
public final 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 final String description() {
return description;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code isEmpty()} method on the property). This is useful
* because the SDK will never return a null collection or map, but you may need to differentiate between the service
* returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
* if a value for the property was specified in the request builder, and false if a value was not specified.
*/
public final boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key name
* and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User
* Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request
* fails and the resource is not created.
*
*
*
* Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
*
*
* This method will never return null. If you would like to know whether the service returned this field (so that
* you can differentiate between null and empty), you can use the {@link #hasTags} method.
*
*
* @return A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key
* name and an associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
*/
public final List tags() {
return tags;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(policyName());
hashCode = 31 * hashCode + Objects.hashCode(path());
hashCode = 31 * hashCode + Objects.hashCode(policyDocument());
hashCode = 31 * hashCode + Objects.hashCode(description());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(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())
&& hasTags() == other.hasTags() && Objects.equals(tags(), other.tags());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("CreatePolicyRequest").add("PolicyName", policyName()).add("Path", path())
.add("PolicyDocument", policyDocument()).add("Description", description()).add("Tags", hasTags() ? tags() : null)
.build();
}
public final 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()));
case "Tags":
return Optional.ofNullable(clazz.cast(tags()));
default:
return Optional.empty();
}
}
@Override
public final 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.
*
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished by
* case. For example, you cannot create resources named both "MyResource" and "myresource".
*
*
* @param policyName
* The friendly name of the policy.
*
* IAM user, group, role, and policy names must be unique within the account. Names are not distinguished
* by case. For example, you cannot create resources named both "MyResource" and "myresource".
* @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.
*
*
*
* You cannot use an asterisk (*) in the path name.
*
*
*
* @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.
*
*
*
* You cannot use an asterisk (*) in the path name.
*
* @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.
*
*
* You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you
* can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format
* before submitting it to IAM.
*
*
* The maximum length of the policy document that you can pass in this operation, including whitespace, is
* listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
*
*
* To learn more about JSON policy grammar, see Grammar of the IAM
* JSON policy language in the IAM User Guide.
*
*
* 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 (\u0020) 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 (\u0009), line feed (\u000A), and carriage return (
* \u000D)
*
*
*
*
* @param policyDocument
* The JSON policy document that you want to use as the content for the new policy.
*
* You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in
* YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy
* to JSON format before submitting it to IAM.
*
*
* The maximum length of the policy document that you can pass in this operation, including whitespace,
* is listed below. To view the maximum character counts of a managed policy with no whitespaces, see IAM and STS character quotas.
*
*
* To learn more about JSON policy grammar, see Grammar of the
* IAM JSON policy language in the IAM User Guide.
*
*
* 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 (\u0020) 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 (\u0009), line feed (\u000A), and carriage return
* (\u000D)
*
*
* @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);
/**
*
* A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key
* name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a
* key name and an associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection tags);
/**
*
* A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key
* name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
*
*
* @param tags
* A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a
* key name and an associated value. For more information about tagging, see Tagging IAM resources in the
* IAM User Guide.
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Tag... tags);
/**
*
* A list of tags that you want to attach to the new IAM customer managed policy. Each tag consists of a key
* name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM
* User Guide.
*
*
*
* If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire
* request fails and the resource is not created.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.iam.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.iam.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.iam.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.iam.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
@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 List tags = DefaultSdkAutoConstructList.getInstance();
private BuilderImpl() {
}
private BuilderImpl(CreatePolicyRequest model) {
super(model);
policyName(model.policyName);
path(model.path);
policyDocument(model.policyDocument);
description(model.description);
tags(model.tags);
}
public final String getPolicyName() {
return policyName;
}
public final void setPolicyName(String policyName) {
this.policyName = policyName;
}
@Override
public final Builder policyName(String policyName) {
this.policyName = policyName;
return this;
}
public final String getPath() {
return path;
}
public final void setPath(String path) {
this.path = path;
}
@Override
public final Builder path(String path) {
this.path = path;
return this;
}
public final String getPolicyDocument() {
return policyDocument;
}
public final void setPolicyDocument(String policyDocument) {
this.policyDocument = policyDocument;
}
@Override
public final Builder policyDocument(String policyDocument) {
this.policyDocument = policyDocument;
return this;
}
public final String getDescription() {
return description;
}
public final void setDescription(String description) {
this.description = description;
}
@Override
public final Builder description(String description) {
this.description = description;
return this;
}
public final List getTags() {
List result = _tagListTypeCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = _tagListTypeCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = _tagListTypeCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
@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;
}
}
}