Package software.amazon.awssdk.policybuilder.iam

Interface IamPrincipal

All Superinterfaces:

ToCopyableBuilder<IamPrincipal.Builder,IamPrincipal>

All Known Implementing Classes:

DefaultIamPrincipal

@ThreadSafe
public interface IamPrincipal
extends ToCopyableBuilder<IamPrincipal.Builder,IamPrincipal>

The Principal element of a IamStatement, specifying who the statement should apply to.

See Also:

Principal user guide

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	IamPrincipal.Builder

Field Summary

Fields

Modifier and Type	Field	Description
static IamPrincipal	ALL	An IamPrincipal representing ALL principals.

Method Summary

Modifier and Type	Method	Description
static IamPrincipal.Builder	builder()	Create a IamStatement.Builder for an IamPrincipal.
static IamPrincipal	create(String principalType, String principalId)	Create an IamPrincipal of the supplied type and ID (see IamPrincipal.Builder.type(String) and IamPrincipal.Builder.id(String)).
static IamPrincipal	create(IamPrincipalType principalType, String principalId)	Create an IamPrincipal of the supplied type and ID (see IamPrincipal.Builder.type(IamPrincipalType) and IamPrincipal.Builder.id(String)).
static List<IamPrincipal>	createAll(String principalType, Collection<String> principalIds)	Create multiple IamPrincipals with the same IamPrincipalType and different IDs (see IamPrincipal.Builder.type(String) and IamPrincipal.Builder.id(String)).
static List<IamPrincipal>	createAll(IamPrincipalType principalType, Collection<String> principalIds)	Create multiple IamPrincipals with the same IamPrincipalType and different IDs (see IamPrincipal.Builder.type(IamPrincipalType) and IamPrincipal.Builder.id(String)).
String	id()	Retrieve the value set by IamPrincipal.Builder.id(String).
IamPrincipalType	type()	Retrieve the value set by IamPrincipal.Builder.type(IamPrincipalType).

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

copy, toBuilder

Field Detail

ALL

static final IamPrincipal ALL

An IamPrincipal representing ALL principals. When used on a statement, it means the policy should apply to everyone.

Method Detail

create

static IamPrincipal create(IamPrincipalType principalType,
                           String principalId)

Create an IamPrincipal of the supplied type and ID (see IamPrincipal.Builder.type(IamPrincipalType) and IamPrincipal.Builder.id(String)).

Both type and ID are required. This is equivalent to IamPrincipal.builder().type(principalType).id(principalId) .build().

create

static IamPrincipal create(String principalType,
                           String principalId)

Create an IamPrincipal of the supplied type and ID (see IamPrincipal.Builder.type(String) and IamPrincipal.Builder.id(String)).

Both type and ID are required. This is equivalent to create(IamPrincipalType, String), except you do not need to call IamPrincipalType.create().

createAll

static List<IamPrincipal> createAll(IamPrincipalType principalType,
                                    Collection<String> principalIds)

Create multiple IamPrincipals with the same IamPrincipalType and different IDs (see IamPrincipal.Builder.type(IamPrincipalType) and IamPrincipal.Builder.id(String)).

Type is required, and the IDs in the IDs list must not be null. This is equivalent to calling create(IamPrincipalType, String) multiple times and collecting the results into a list.

createAll

static List<IamPrincipal> createAll(String principalType,
                                    Collection<String> principalIds)

Create multiple IamPrincipals with the same IamPrincipalType and different IDs (see IamPrincipal.Builder.type(String) and IamPrincipal.Builder.id(String)).

Type is required, and the IDs in the IDs list must not be null. This is equivalent to calling create(String, String) multiple times and collecting the results into a list.

builder

static IamPrincipal.Builder builder()

Create a IamStatement.Builder for an IamPrincipal.

type

IamPrincipalType type()

Retrieve the value set by IamPrincipal.Builder.type(IamPrincipalType).

id

String id()

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