Class DefaultIamPolicy

java.lang.Object

software.amazon.awssdk.policybuilder.iam.internal.DefaultIamPolicy

All Implemented Interfaces:

IamPolicy, ToCopyableBuilder<IamPolicy.Builder,IamPolicy>

public final class DefaultIamPolicy
extends Object
implements IamPolicy

Default implementation of IamPolicy.

See Also:

• IamPolicy.create(java.util.Collection<software.amazon.awssdk.policybuilder.iam.IamStatement>)
• IamPolicy.fromJson(String)
• IamPolicy.builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DefaultIamPolicy.Builder

Constructor Summary

Constructors

Constructor	Description
DefaultIamPolicy(DefaultIamPolicy.Builder builder)

Method Summary

Modifier and Type	Method	Description
static DefaultIamPolicy.Builder	builder()
boolean	equals(Object o)
int	hashCode()
String	id()	Retrieve the value set by IamPolicy.Builder.id(String).
List<IamStatement>	statements()	Retrieve the value set by IamPolicy.Builder.statements(Collection).
DefaultIamPolicy.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toJson()	Convert this policy to the JSON format that is accepted by AWS services.
String	toJson(IamPolicyWriter writer)	Convert this policy to the JSON format that is accepted by AWS services, using the provided writer.
String	toString()
String	version()	Retrieve the value set by IamPolicy.Builder.version(String).

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Constructor Details

DefaultIamPolicy

public DefaultIamPolicy(DefaultIamPolicy.Builder builder)

Method Details

builder

public static DefaultIamPolicy.Builder builder()

id

public String id()

Description copied from interface: IamPolicy

Retrieve the value set by IamPolicy.Builder.id(String).

Specified by:

id in interface IamPolicy

version

public String version()

Description copied from interface: IamPolicy

Retrieve the value set by IamPolicy.Builder.version(String).

Specified by:

version in interface IamPolicy

statements

public List<IamStatement> statements()

Description copied from interface: IamPolicy

Retrieve the value set by IamPolicy.Builder.statements(Collection).

Specified by:

statements in interface IamPolicy

toJson

public String toJson()

Description copied from interface: IamPolicy

Convert this policy to the JSON format that is accepted by AWS services.

This is equivalent to IamPolicyWriter.create().writeToString(policy)

IamPolicy policy =
    IamPolicy.builder()
             .addStatement(IamStatement.builder()
                                       .effect(IamEffect.ALLOW)
                                       .addAction("dynamodb:PutItem")
                                       .addResource("arn:aws:dynamodb:us-east-2:123456789012:table/books")
                                       .build())
             .build();
System.out.println("Policy:\n" + policy.toJson());

Specified by:

toJson in interface IamPolicy

toJson

public String toJson(IamPolicyWriter writer)

Description copied from interface: IamPolicy

Convert this policy to the JSON format that is accepted by AWS services, using the provided writer.

This is equivalent to writer.writeToString(policy)

IamPolicyWriter prettyWriter =
    IamPolicyWriter.builder()
                   .prettyPrint(true)
                   .build();
IamPolicy policy =
    IamPolicy.builder()
             .addStatement(IamStatement.builder()
                                       .effect(IamEffect.ALLOW)
                                       .addAction("dynamodb:PutItem")
                                       .addResource("arn:aws:dynamodb:us-east-2:123456789012:table/books")
                                       .build())
             .build();
System.out.println("Policy:\n" + policy.toJson(prettyWriter));

Specified by:

toJson in interface IamPolicy

toBuilder

public DefaultIamPolicy.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<IamPolicy.Builder,IamPolicy>

Returns:

a builder for type T

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object