software.amazon.awscdk.services.iam

Class PolicyStatement.Builder

java.lang.Object

software.amazon.awscdk.services.iam.PolicyStatement.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PolicyStatement>

Enclosing class:

PolicyStatement

@Stability(value=Experimental)
public static final class PolicyStatement.Builder
extends Object
implements software.amazon.jsii.Builder<PolicyStatement>

(experimental) A fluent builder for PolicyStatement.

Method Summary

Modifier and Type	Method and Description
PolicyStatement.Builder	actions(List<String> actions) (experimental) List of actions to add to the statement.
PolicyStatement	build()
PolicyStatement.Builder	conditions(Map<String,? extends Object> conditions) (experimental) Conditions to add to the statement.
static PolicyStatement.Builder	create()
PolicyStatement.Builder	effect(Effect effect) (experimental) Whether to allow or deny the actions in this statement.
PolicyStatement.Builder	notActions(List<String> notActions) (experimental) List of not actions to add to the statement.
PolicyStatement.Builder	notPrincipals(List<? extends IPrincipal> notPrincipals) (experimental) List of not principals to add to the statement.
PolicyStatement.Builder	notResources(List<String> notResources) (experimental) NotResource ARNs to add to the statement.
PolicyStatement.Builder	principals(List<? extends IPrincipal> principals) (experimental) List of principals to add to the statement.
PolicyStatement.Builder	resources(List<String> resources) (experimental) Resource ARNs to add to the statement.
PolicyStatement.Builder	sid(String sid) (experimental) The Sid (statement ID) is an optional identifier that you provide for the policy statement.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(value=Experimental)
public static PolicyStatement.Builder create()

Returns:

a new instance of PolicyStatement.Builder.

actions

@Stability(value=Experimental)
public PolicyStatement.Builder actions(List<String> actions)

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

Default: - no actions

Parameters:

actions - List of actions to add to the statement. This parameter is required.

Returns:

this

conditions

@Stability(value=Experimental)
public PolicyStatement.Builder conditions(Map<String,? extends Object> conditions)

(experimental) Conditions to add to the statement.

Default: - no condition

Parameters:

conditions - Conditions to add to the statement. This parameter is required.

Returns:

this

effect

@Stability(value=Experimental)
public PolicyStatement.Builder effect(Effect effect)

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

Default: Effect.ALLOW

Parameters:

effect - Whether to allow or deny the actions in this statement. This parameter is required.

Returns:

this

notActions

@Stability(value=Experimental)
public PolicyStatement.Builder notActions(List<String> notActions)

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

Default: - no not-actions

Parameters:

notActions - List of not actions to add to the statement. This parameter is required.

Returns:

this

notPrincipals

@Stability(value=Experimental)
public PolicyStatement.Builder notPrincipals(List<? extends IPrincipal> notPrincipals)

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

Default: - no not principals

Parameters:

notPrincipals - List of not principals to add to the statement. This parameter is required.

Returns:

this

notResources

@Stability(value=Experimental)
public PolicyStatement.Builder notResources(List<String> notResources)

(experimental) NotResource ARNs to add to the statement.

Default: - no not-resources

Parameters:

notResources - NotResource ARNs to add to the statement. This parameter is required.

Returns:

this

principals

@Stability(value=Experimental)
public PolicyStatement.Builder principals(List<? extends IPrincipal> principals)

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

Default: - no principals

Parameters:

principals - List of principals to add to the statement. This parameter is required.

Returns:

this

resources

@Stability(value=Experimental)
public PolicyStatement.Builder resources(List<String> resources)

(experimental) Resource ARNs to add to the statement.

Default: - no resources

Parameters:

resources - Resource ARNs to add to the statement. This parameter is required.

Returns:

this

sid

@Stability(value=Experimental)
public PolicyStatement.Builder sid(String sid)

(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

Parameters:

sid - The Sid (statement ID) is an optional identifier that you provide for the policy statement. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public PolicyStatement build()

Specified by:

build in interface software.amazon.jsii.Builder<PolicyStatement>