Class DefaultIamPolicy.Builder
- All Implemented Interfaces:
IamPolicy.Builder
,Buildable
,CopyableBuilder<IamPolicy.Builder,
,IamPolicy> SdkBuilder<IamPolicy.Builder,
IamPolicy>
- Enclosing class:
DefaultIamPolicy
-
Method Summary
Modifier and TypeMethodDescriptionaddStatement
(Consumer<IamStatement.Builder> statement) Append aStatement
element to this policy to specify additional access rules.addStatement
(IamStatement statement) Append aStatement
element to this policy to specify additional access rules.build()
An immutable object that is created from the properties that have been set on the builder.Configure theId
element of the policy, specifying an optional identifier for the policy.statements
(Collection<IamStatement> statements) Configure theStatement
element of the policy, specifying the access rules for this policy.Configure theVersion
element of the policy, specifying the language syntax rules that are to be used to process the policy.Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation
-
Method Details
-
id
Description copied from interface:IamPolicy.Builder
Configure theId
element of the policy, specifying an optional identifier for the policy.The ID is used differently in different services. ID is allowed in resource-based policies, but not in identity-based policies.
For services that let you set an ID element, we recommend you use a UUID (GUID) for the value, or incorporate a UUID as part of the ID to ensure uniqueness.
This value is optional.
IamPolicy policy = IamPolicy.builder() .id("cd3ad3d9-2776-4ef1-a904-4c229d1642ee") // An identifier for the policy .addStatement(IamStatement.builder() .effect(IamEffect.DENY) .addAction(IamAction.ALL) .build()) .build();
- Specified by:
id
in interfaceIamPolicy.Builder
- See Also:
-
version
Description copied from interface:IamPolicy.Builder
Configure theVersion
element of the policy, specifying the language syntax rules that are to be used to process the policy.By default, this value is
2012-10-17
.IamPolicy policy = IamPolicy.builder() .version("2012-10-17") // The IAM policy language syntax version to use .addStatement(IamStatement.builder() .effect(IamEffect.DENY) .addAction(IamAction.ALL) .build()) .build();
- Specified by:
version
in interfaceIamPolicy.Builder
- See Also:
-
statements
Description copied from interface:IamPolicy.Builder
Configure theStatement
element of the policy, specifying the access rules for this policy.This will replace any other statements already added to the policy. At least one statement is required to create a policy.
IamPolicy policy = IamPolicy.builder() // Add a statement to this policy that denies all actions: .statements(Arrays.asList(IamStatement.builder() .effect(IamEffect.DENY) .addAction(IamAction.ALL) .build())) .build();
- Specified by:
statements
in interfaceIamPolicy.Builder
- See Also:
-
addStatement
Description copied from interface:IamPolicy.Builder
Append aStatement
element to this policy to specify additional access rules.At least one statement is required to create a policy.
IamPolicy policy = IamPolicy.builder() // Add a statement to this policy that denies all actions: .addStatement(IamStatement.builder() .effect(IamEffect.DENY) .addAction(IamAction.ALL) .build()) .build();
- Specified by:
addStatement
in interfaceIamPolicy.Builder
- See Also:
-
addStatement
Description copied from interface:IamPolicy.Builder
Append aStatement
element to this policy to specify additional access rules.This works the same as
IamPolicy.Builder.addStatement(IamStatement)
, except you do not need to specifyIamStatement .builder()
orbuild()
. At least one statement is required to create a policy.IamPolicy policy = IamPolicy.builder() // Add a statement to this policy that denies all actions: .addStatement(s -> s.effect(IamEffect.DENY) .addAction(IamAction.ALL)) .build();
- Specified by:
addStatement
in interfaceIamPolicy.Builder
- See Also:
-
build
Description copied from interface:SdkBuilder
An immutable object that is created from the properties that have been set on the builder.- Specified by:
build
in interfaceBuildable
- Specified by:
build
in interfaceSdkBuilder<IamPolicy.Builder,
IamPolicy> - Returns:
- an instance of T
-