Package software.amazon.awssdk.services.iam.model

Class CreatePolicyRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.iam.model.CreatePolicyRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreatePolicyRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePolicyRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static CreatePolicyRequest.Builder	builder()
String	description()	A friendly description of the policy.
boolean	equals(Object obj)
int	hashCode()
String	path()	The path for the policy.
String	policyDocument()	The JSON policy document that you want to use as the content for the new policy.
String	policyName()	The friendly name of the policy.
static Class<? extends CreatePolicyRequest.Builder>	serializableBuilderClass()
CreatePolicyRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

policyName

public String policyName()

The friendly name of the policy.

This parameter allows (per 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: =,.@-

Returns:

The friendly name of the policy.

This parameter allows (per 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: =,.@-

path

public String 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 paramater allows (per 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, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Returns:

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 paramater allows (per 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, containing any ASCII character from the ! (!) thru the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

policyDocument

public String 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 any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

Returns:

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 any printable ASCII character ranging from the space character ( ) through end of the ASCII character range as well as the printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ). It also includes the special characters tab ( ), line feed ( ), and carriage return ( ).

description

public String 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.

Returns:

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.

toBuilder

public CreatePolicyRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>

Returns:

a builder for type T

builder

public static CreatePolicyRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePolicyRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object