-
Notifications
You must be signed in to change notification settings - Fork 5.8k
Java v2: Add IAM Policy Builder API examples #5188
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
rlhagerm
merged 3 commits into
awsdocs:main
from
tkhill-AWS:iam_policy_builder_examples
Aug 11, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
249 changes: 249 additions & 0 deletions
249
javav2/example_code/iam/src/main/java/com/example/iam/IamPolicyBuilderExamples.java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,249 @@ | ||
| /* | ||
| * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| package com.example.iam; | ||
|
|
||
| // snippet-start:[iam.java2.policy_builder.policy_builder_examples.imports] | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import software.amazon.awssdk.policybuilder.iam.IamConditionOperator; | ||
| import software.amazon.awssdk.policybuilder.iam.IamEffect; | ||
| import software.amazon.awssdk.policybuilder.iam.IamPolicy; | ||
| import software.amazon.awssdk.policybuilder.iam.IamPolicyWriter; | ||
| import software.amazon.awssdk.policybuilder.iam.IamPrincipal; | ||
| import software.amazon.awssdk.policybuilder.iam.IamPrincipalType; | ||
| import software.amazon.awssdk.policybuilder.iam.IamResource; | ||
| import software.amazon.awssdk.policybuilder.iam.IamStatement; | ||
| import software.amazon.awssdk.regions.Region; | ||
| import software.amazon.awssdk.services.iam.IamClient; | ||
| import software.amazon.awssdk.services.iam.model.GetPolicyResponse; | ||
| import software.amazon.awssdk.services.iam.model.GetPolicyVersionResponse; | ||
| import software.amazon.awssdk.services.sts.StsClient; | ||
|
|
||
| import java.net.URLDecoder; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.Arrays; | ||
| import java.util.List; | ||
| // snippet-end:[iam.java2.policy_builder.policy_builder_examples.imports] | ||
|
|
||
| public class IamPolicyBuilderExamples { | ||
| private static final Logger logger = LoggerFactory.getLogger(IamPolicyBuilderExamples.class); | ||
|
|
||
| public static void main(String[] args) { | ||
| IamPolicyBuilderExamples iamPolicyBuilderExamples = new IamPolicyBuilderExamples(); | ||
| // snippet-start:[iam.java2.policy_builder.policy_builder_examples.iamclient_build] | ||
| IamClient iam = IamClient.builder().region(Region.AWS_GLOBAL).build(); | ||
| // snippet-end:[iam.java2.policy_builder.policy_builder_examples.iamclient_build] | ||
|
|
||
| iamPolicyBuilderExamples.runCreateAndUploadPolicyExample(iam); | ||
| iamPolicyBuilderExamples.runCreateNewBasedOnExisingPolicyExample(iam); | ||
|
|
||
| if (iam != null) { | ||
| iam.close(); | ||
| } | ||
|
|
||
| iamPolicyBuilderExamples.runTimeBasedPolicyExample(); | ||
| iamPolicyBuilderExamples.runMultipleConditionsExample(); | ||
| iamPolicyBuilderExamples.runSpecifyPrincipalsExample(); | ||
| iamPolicyBuilderExamples.runAllowCrossAccountAccessExample(); | ||
| } | ||
|
|
||
| // snippet-start:[iam.java2.policy_builder.create_and_upload_policy] | ||
| public String createAndUploadPolicyExample(IamClient iam, String accountID, String policyName) { | ||
| // Build the policy. | ||
| IamPolicy policy = | ||
| IamPolicy.builder() // 'version' defaults to "2012-10-17". | ||
| .addStatement(IamStatement.builder() | ||
| .effect(IamEffect.ALLOW) | ||
| .addAction("dynamodb:PutItem") | ||
| .addResource("arn:aws:dynamodb:us-east-1:" + accountID + ":table/exampleTableName") | ||
| .build()) | ||
| .build(); | ||
| // Upload the policy. | ||
| iam.createPolicy(r -> r.policyName(policyName).policyDocument(policy.toJson())); | ||
| return policy.toJson(IamPolicyWriter.builder().prettyPrint(true).build()); | ||
| } | ||
| // snippet-end:[iam.java2.policy_builder.create_and_upload_policy] | ||
|
|
||
| private void runCreateAndUploadPolicyExample(IamClient iam) { | ||
| String accountId = getAccountID(); | ||
| String policyName = "AllowPutItemToExampleTable"; | ||
|
|
||
| String jsonPolicy = createAndUploadPolicyExample(iam, accountId, policyName); | ||
| logger.info(jsonPolicy); | ||
|
|
||
| GetPolicyResponse putItemPolicy = iam.getPolicy(b -> b.policyArn("arn:aws:iam::" + accountId + ":policy/" + policyName)); | ||
| iam.deletePolicy(b -> b.policyArn(putItemPolicy.policy().arn())); | ||
| logger.info("Policy [{}] deleted", putItemPolicy.policy().arn()); | ||
| } | ||
|
|
||
| // snippet-start:[iam.java2.policy_builder.create_new_based_on_existing_policy] | ||
| public String createNewBasedOnExistingPolicyExample(IamClient iam, String accountID, String policyName, String newPolicyName) { | ||
|
|
||
| String policyArn = "arn:aws:iam::" + accountID + ":policy/" + policyName; | ||
| GetPolicyResponse getPolicyResponse = iam.getPolicy(r -> r.policyArn(policyArn)); | ||
|
|
||
| String policyVersion = getPolicyResponse.policy().defaultVersionId(); | ||
| GetPolicyVersionResponse getPolicyVersionResponse = | ||
| iam.getPolicyVersion(r -> r.policyArn(policyArn).versionId(policyVersion)); | ||
|
|
||
| // Create an IamPolicy instance from the JSON string returned from IAM. | ||
| String decodedPolicy = URLDecoder.decode(getPolicyVersionResponse.policyVersion().document(), StandardCharsets.UTF_8); | ||
| IamPolicy policy = IamPolicy.fromJson(decodedPolicy); | ||
|
|
||
| /* | ||
| All IamPolicy components are immutable, so use the copy method that creates a new instance that | ||
| can be altered in the same method call. | ||
|
|
||
| Add the ability to get an item from DynamoDB as an additional action. | ||
| */ | ||
| IamStatement newStatement = policy.statements().get(0).copy(s -> s.addAction("dynamodb:GetItem")); | ||
|
|
||
| // Create a new statement that replaces the original statement. | ||
| IamPolicy newPolicy = policy.copy(p -> p.statements(Arrays.asList(newStatement))); | ||
|
|
||
| // Upload the new policy. IAM now has both policies. | ||
| iam.createPolicy(r -> r.policyName(newPolicyName) | ||
| .policyDocument(newPolicy.toJson())); | ||
|
|
||
| return newPolicy.toJson(IamPolicyWriter.builder().prettyPrint(true).build()); | ||
| } | ||
| // snippet-end:[iam.java2.policy_builder.create_new_based_on_existing_policy] | ||
|
|
||
| private void runCreateNewBasedOnExisingPolicyExample(IamClient iam) { | ||
| String accountID = getAccountID(); | ||
| String policyName = "AllowPutItemToExampleTable"; | ||
| String newPolicyName = "AllowGetAndPutItemToExampleTable"; | ||
| // First part of the example is to create the policy. | ||
| String jsonPolicy = createAndUploadPolicyExample(iam, accountID, policyName); | ||
| logger.info(jsonPolicy); | ||
|
|
||
| String jsonNewPolicy = createNewBasedOnExistingPolicyExample(iam, accountID, policyName, newPolicyName); | ||
| logger.info(jsonNewPolicy); | ||
|
|
||
| // Delete the two policies | ||
| GetPolicyResponse putItemPolicy = iam.getPolicy(b -> b.policyArn("arn:aws:iam::" + accountID + ":policy/" + policyName)); | ||
| iam.deletePolicy(b -> b.policyArn(putItemPolicy.policy().arn())); | ||
| logger.info("Policy [{}] deleted", putItemPolicy.policy().arn()); | ||
|
|
||
| GetPolicyResponse getAndPutItemPolicy = iam.getPolicy(b -> b.policyArn("arn:aws:iam::" + accountID + ":policy/" + newPolicyName)); | ||
| iam.deletePolicy(b -> b.policyArn(getAndPutItemPolicy.policy().arn())); | ||
| logger.info("Policy [{}] deleted", getAndPutItemPolicy.policy().arn()); | ||
| } | ||
|
|
||
| // snippet-start:[iam.java2.policy_builder.multiple_conditions] | ||
| public String multipleConditionsExample() { | ||
| IamPolicy policy = IamPolicy.builder() | ||
| .addStatement(b -> b | ||
| .effect(IamEffect.ALLOW) | ||
| .addAction("dynamodb:GetItem") | ||
| .addAction("dynamodb:BatchGetItem") | ||
| .addAction("dynamodb:Query") | ||
| .addAction("dynamodb:PutItem") | ||
| .addAction("dynamodb:UpdateItem") | ||
| .addAction("dynamodb:DeleteItem") | ||
| .addAction("dynamodb:BatchWriteItem") | ||
| .addResource("arn:aws:dynamodb:*:*:table/table-name") | ||
| .addConditions(IamConditionOperator.STRING_EQUALS.addPrefix("ForAllValues:"), | ||
| "dynamodb:Attributes", | ||
| List.of("column-name1", "column-name2", "column-name3")) | ||
| .addCondition(b1 -> b1.operator(IamConditionOperator.STRING_EQUALS.addSuffix("IfExists")) | ||
| .key("dynamodb:Select") | ||
| .value("SPECIFIC_ATTRIBUTES"))) | ||
| .build(); | ||
|
|
||
| return policy.toJson(IamPolicyWriter.builder() | ||
| .prettyPrint(true).build()); | ||
| } | ||
| // snippet-end:[iam.java2.policy_builder.multiple_conditions] | ||
|
|
||
| private void runMultipleConditionsExample() { | ||
| String jsonPolicy = multipleConditionsExample(); | ||
| logger.info(jsonPolicy); | ||
|
|
||
| } | ||
|
|
||
| // snippet-start:[iam.java2.policy_builder.time_based] | ||
| public String timeBasedPolicyExample() { | ||
| IamPolicy policy = IamPolicy.builder() | ||
| .addStatement(b -> b | ||
| .effect(IamEffect.ALLOW) | ||
| .addAction("dynamodb:GetItem") | ||
| .addResource(IamResource.ALL) | ||
| .addCondition(b1 -> b1 | ||
| .operator(IamConditionOperator.DATE_GREATER_THAN) | ||
| .key("aws:CurrentTime") | ||
| .value("2020-04-01T00:00:00Z")) | ||
| .addCondition(b1 -> b1 | ||
| .operator(IamConditionOperator.DATE_LESS_THAN) | ||
| .key("aws:CurrentTime") | ||
| .value("2020-06-30T23:59:59Z"))) | ||
| .build(); | ||
|
|
||
| // Use an IamPolicyWriter to write out the JSON string to a more readable format. | ||
| return policy.toJson(IamPolicyWriter.builder() | ||
| .prettyPrint(true) | ||
| .build()); | ||
| } | ||
| // snippet-end:[iam.java2.policy_builder.time_based] | ||
|
|
||
| private void runTimeBasedPolicyExample() { | ||
| String policyJson = timeBasedPolicyExample(); | ||
| logger.info(policyJson); | ||
| } | ||
|
|
||
| // snippet-start:[iam.java2.policy_builder.specify_principals] | ||
| public String specifyPrincipalsExample() { | ||
| IamPolicy policy = IamPolicy.builder() | ||
| .addStatement(b -> b | ||
| .effect(IamEffect.DENY) | ||
| .addAction("s3:*") | ||
| .addPrincipal(IamPrincipal.ALL) | ||
| .addResource("arn:aws:s3:::BUCKETNAME/*") | ||
| .addResource("arn:aws:s3:::BUCKETNAME") | ||
| .addCondition(b1 -> b1 | ||
| .operator(IamConditionOperator.ARN_NOT_EQUALS) | ||
| .key("aws:PrincipalArn") | ||
| .value("arn:aws:iam::444455556666:user/user-name"))) | ||
| .build(); | ||
| return policy.toJson(IamPolicyWriter.builder() | ||
| .prettyPrint(true).build()); | ||
| } | ||
| // snippet-end:[iam.java2.policy_builder.specify_principals] | ||
|
|
||
| private void runSpecifyPrincipalsExample() { | ||
| String policyJson = specifyPrincipalsExample(); | ||
| logger.info(policyJson); | ||
| } | ||
|
|
||
| // snippet-start:[iam.java2.policy_builder.allow_cross_account_access] | ||
| public String allowCrossAccountAccessExample() { | ||
| IamPolicy policy = IamPolicy.builder() | ||
| .addStatement(b -> b | ||
| .effect(IamEffect.ALLOW) | ||
| .addPrincipal(IamPrincipalType.AWS, "111122223333") | ||
| .addAction("s3:PutObject") | ||
| .addResource("arn:aws:s3:::DOC-EXAMPLE-BUCKET/*") | ||
| .addCondition(b1 -> b1 | ||
| .operator(IamConditionOperator.STRING_EQUALS) | ||
| .key("s3:x-amz-acl") | ||
| .value("bucket-owner-full-control"))) | ||
| .build(); | ||
| return policy.toJson(IamPolicyWriter.builder() | ||
| .prettyPrint(true).build()); | ||
| } | ||
| // snippet-end:[iam.java2.policy_builder.allow_cross_account_access] | ||
|
|
||
| private void runAllowCrossAccountAccessExample() { | ||
| String policyJson = allowCrossAccountAccessExample(); | ||
| logger.info(policyJson); | ||
| } | ||
|
|
||
| String getAccountID() { | ||
| try (StsClient stsClient = StsClient.create()) { | ||
| return stsClient.getCallerIdentity().account(); | ||
| } | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| <Configuration status="WARN"> | ||
| <Appenders> | ||
| <Console name="ConsoleAppender" target="SYSTEM_OUT"> | ||
| <PatternLayout pattern="%d{YYYY-MM-dd HH:mm:ss} [%t] %-5p %c:%L - %m%n" /> | ||
| </Console> | ||
| </Appenders> | ||
|
|
||
| <Loggers> | ||
| <Root level="WARN"> | ||
| <AppenderRef ref="ConsoleAppender"/> | ||
| </Root> | ||
| <Logger name="software.amazon.awssdk" level="WARN" /> | ||
| <Logger name="software.amazon.awssdk.request" level="INFO" /> | ||
| <Logger name="org.apache.http.wire" level="INFO" /> | ||
| <logger name="com.example.iam" level="INFO" /> | ||
| </Loggers> | ||
| </Configuration> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.