software.amazon.awscdk.services.iam

Interface PolicyStatementProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

PolicyStatementProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:32.022Z")
 @Stability(value=Experimental)
public interface PolicyStatementProps
extends software.amazon.jsii.JsiiSerializable

(experimental) Interface for creating a policy statement.

Example:

 // Add gateway endpoints when creating the VPC
 Vpc vpc = Vpc.Builder.create(this, "MyVpc")
         .gatewayEndpoints(Map.of(
                 "S3", GatewayVpcEndpointOptions.builder()
                         .service(GatewayVpcEndpointAwsService.S3)
                         .build()))
         .build();
 // Alternatively gateway endpoints can be added on the VPC
 GatewayVpcEndpoint dynamoDbEndpoint = vpc.addGatewayEndpoint("DynamoDbEndpoint", GatewayVpcEndpointOptions.builder()
         .service(GatewayVpcEndpointAwsService.DYNAMODB)
         .build());
 // This allows to customize the endpoint policy
 dynamoDbEndpoint.addToPolicy(
 PolicyStatement.Builder.create() // Restrict to listing and describing tables
         .principals(List.of(new AnyPrincipal()))
         .actions(List.of("dynamodb:DescribeTable", "dynamodb:ListTables"))
         .resources(List.of("*")).build());
 // Add an interface endpoint
 vpc.addInterfaceEndpoint("EcrDockerEndpoint", InterfaceVpcEndpointOptions.builder()
         .service(InterfaceVpcEndpointAwsService.ECR_DOCKER)
         .build());
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PolicyStatementProps.Builder A builder for PolicyStatementProps
static class	PolicyStatementProps.Jsii$Proxy An implementation for PolicyStatementProps

Method Summary

Modifier and Type	Method and Description
static PolicyStatementProps.Builder	builder()
default List<String>	getActions() (experimental) List of actions to add to the statement.
default Map<String,Object>	getConditions() (experimental) Conditions to add to the statement.
default Effect	getEffect() (experimental) Whether to allow or deny the actions in this statement.
default List<String>	getNotActions() (experimental) List of not actions to add to the statement.
default List<IPrincipal>	getNotPrincipals() (experimental) List of not principals to add to the statement.
default List<String>	getNotResources() (experimental) NotResource ARNs to add to the statement.
default List<IPrincipal>	getPrincipals() (experimental) List of principals to add to the statement.
default List<String>	getResources() (experimental) Resource ARNs to add to the statement.
default String	getSid() (experimental) The Sid (statement ID) is an optional identifier that you provide for the policy statement.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getActions

@Stability(value=Experimental)
 @Nullable
default List<String> getActions()

(experimental) List of actions to add to the statement.

Default: - no actions

getConditions

@Stability(value=Experimental)
 @Nullable
default Map<String,Object> getConditions()

(experimental) Conditions to add to the statement.

Default: - no condition

getEffect

@Stability(value=Experimental)
 @Nullable
default Effect getEffect()

(experimental) Whether to allow or deny the actions in this statement.

Default: Effect.ALLOW

getNotActions

@Stability(value=Experimental)
 @Nullable
default List<String> getNotActions()

(experimental) List of not actions to add to the statement.

Default: - no not-actions

getNotPrincipals

@Stability(value=Experimental)
 @Nullable
default List<IPrincipal> getNotPrincipals()

(experimental) List of not principals to add to the statement.

Default: - no not principals

getNotResources

@Stability(value=Experimental)
 @Nullable
default List<String> getNotResources()

(experimental) NotResource ARNs to add to the statement.

Default: - no not-resources

getPrincipals

@Stability(value=Experimental)
 @Nullable
default List<IPrincipal> getPrincipals()

(experimental) List of principals to add to the statement.

Default: - no principals

getResources

@Stability(value=Experimental)
 @Nullable
default List<String> getResources()

(experimental) Resource ARNs to add to the statement.

Default: - no resources

getSid

@Stability(value=Experimental)
 @Nullable
default String getSid()

(experimental) The Sid (statement ID) is an optional identifier that you provide for the policy statement.

You can assign a Sid value to each statement in a statement array. In services that let you specify an ID element, such as SQS and SNS, the Sid value is just a sub-ID of the policy document's ID. In IAM, the Sid value must be unique within a JSON policy.

Default: - no sid

builder

@Stability(value=Experimental)
static PolicyStatementProps.Builder builder()

Returns:

a PolicyStatementProps.Builder of PolicyStatementProps