@Generated(value="software.amazon.awssdk:codegen") public final class CreatePolicyRequest extends IamRequest implements ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreatePolicyRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreatePolicyRequest.Builder |
builder() |
String |
description()
A friendly description of the policy.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
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.
|
List<SdkField<?>> |
sdkFields() |
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()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final String 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".
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 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 ! (!) through the DEL
character (), including most punctuation characters, digits, and upper and lowercased letters.
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 ! (!) through
the DEL character (), including most punctuation characters, digits, and upper and
lowercased letters.
public final String 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 AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
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 ÿ)
The special characters tab ( ), line feed (
), and carriage return (
)
You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.
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
ÿ)
The special characters tab ( ), line feed (
), and carriage return (
)
public final 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.
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 CreatePolicyRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<CreatePolicyRequest.Builder,CreatePolicyRequest>toBuilder in class IamRequestpublic static CreatePolicyRequest.Builder builder()
public static Class<? extends CreatePolicyRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.