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:
-
Nested Class Summary
-
Field Summary
Modifier and TypeFieldDescriptionstatic final IamPrincipal
AnIamPrincipal
representing ALL principals. -
Method Summary
Modifier and TypeMethodDescriptionstatic IamPrincipal.Builder
builder()
Create aIamStatement.Builder
for anIamPrincipal
.static IamPrincipal
Create anIamPrincipal
of the supplied type and ID (seeIamPrincipal.Builder.type(String)
andIamPrincipal.Builder.id(String)
).static IamPrincipal
create
(IamPrincipalType principalType, String principalId) Create anIamPrincipal
of the supplied type and ID (seeIamPrincipal.Builder.type(IamPrincipalType)
andIamPrincipal.Builder.id(String)
).static List
<IamPrincipal> createAll
(String principalType, Collection<String> principalIds) Create multipleIamPrincipal
s with the sameIamPrincipalType
and different IDs (seeIamPrincipal.Builder.type(String)
andIamPrincipal.Builder.id(String)
).static List
<IamPrincipal> createAll
(IamPrincipalType principalType, Collection<String> principalIds) Create multipleIamPrincipal
s with the sameIamPrincipalType
and different IDs (seeIamPrincipal.Builder.type(IamPrincipalType)
andIamPrincipal.Builder.id(String)
).id()
Retrieve the value set byIamPrincipal.Builder.id(String)
.type()
Retrieve the value set byIamPrincipal.Builder.type(IamPrincipalType)
.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy, toBuilder
-
Field Details
-
ALL
AnIamPrincipal
representing ALL principals. When used on a statement, it means the policy should apply to everyone.
-
-
Method Details
-
create
Create anIamPrincipal
of the supplied type and ID (seeIamPrincipal.Builder.type(IamPrincipalType)
andIamPrincipal.Builder.id(String)
).Both type and ID are required. This is equivalent to
IamPrincipal.builder().type(principalType).id(principalId) .build()
. -
create
Create anIamPrincipal
of the supplied type and ID (seeIamPrincipal.Builder.type(String)
andIamPrincipal.Builder.id(String)
).Both type and ID are required. This is equivalent to
create(IamPrincipalType, String)
, except you do not need to callIamPrincipalType.create()
. -
createAll
static List<IamPrincipal> createAll(IamPrincipalType principalType, Collection<String> principalIds) Create multipleIamPrincipal
s with the sameIamPrincipalType
and different IDs (seeIamPrincipal.Builder.type(IamPrincipalType)
andIamPrincipal.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
Create multipleIamPrincipal
s with the sameIamPrincipalType
and different IDs (seeIamPrincipal.Builder.type(String)
andIamPrincipal.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
Create aIamStatement.Builder
for anIamPrincipal
. -
type
IamPrincipalType type()Retrieve the value set byIamPrincipal.Builder.type(IamPrincipalType)
. -
id
String id()Retrieve the value set byIamPrincipal.Builder.id(String)
.
-