Package software.amazon.awscdk.cfnpropertymixins.services.iam

Class CfnPolicyPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.iam.CfnPolicyPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnPolicyPropsMixin>

Enclosing class:

CfnPolicyPropsMixin

@Stability(Stable)
public static final class CfnPolicyPropsMixin.Builder
extends Object
implements software.amazon.jsii.Builder<CfnPolicyPropsMixin>

A fluent builder for CfnPolicyPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnPolicyPropsMixin	build()
static CfnPolicyPropsMixin.Builder	create()
static CfnPolicyPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnPolicyPropsMixin.Builder	groups(List<String> groups)	The name of the group to associate the policy with.
CfnPolicyPropsMixin.Builder	policyDocument(Object policyDocument)	The policy document.
CfnPolicyPropsMixin.Builder	policyName(String policyName)	The name of the policy document.
CfnPolicyPropsMixin.Builder	roles(List<String> roles)	The name of the role to associate the policy with.
CfnPolicyPropsMixin.Builder	users(List<String> users)	The name of the user to associate the policy with.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnPolicyPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnPolicyPropsMixin.Builder.

create

@Stability(Stable)
public static CfnPolicyPropsMixin.Builder create()

Returns:

a new instance of CfnPolicyPropsMixin.Builder.

groups

@Stability(Stable)
public CfnPolicyPropsMixin.Builder groups(List<String> groups)

The name of the group to associate the policy with.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-.

Parameters:

groups - The name of the group to associate the policy with. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-groups

policyDocument

@Stability(Stable)
public CfnPolicyPropsMixin.Builder policyDocument(Object policyDocument)

The policy document.

You must provide policies in JSON format in IAM. However, for CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. CloudFormation always converts a YAML policy to JSON format before submitting it to IAM.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

• Any printable ASCII character ranging from the space character ( ) through the end of the ASCII character range
• The printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ )
• The special characters tab ( ), line feed ( ), and carriage return ( )

Parameters:

policyDocument - The policy document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policydocument

policyName

@Stability(Stable)
public CfnPolicyPropsMixin.Builder policyName(String policyName)

The name of the policy document.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Parameters:

policyName - The name of the policy document. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-policyname

roles

@Stability(Stable)
public CfnPolicyPropsMixin.Builder roles(List<String> roles)

The name of the role to associate the policy with.

This parameter allows (per its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

If an external policy (such as AWS::IAM::Policy or AWS::IAM::ManagedPolicy ) has a Ref to a role and if a resource (such as AWS::ECS::Service ) also has a Ref to the same role, add a DependsOn attribute to the resource to make the resource depend on the external policy. This dependency ensures that the role's policy is available throughout the resource's lifecycle. For example, when you delete a stack with an AWS::ECS::Service resource, the DependsOn attribute ensures that CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

Parameters:

roles - The name of the role to associate the policy with. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-roles

users

@Stability(Stable)
public CfnPolicyPropsMixin.Builder users(List<String> users)

The name of the user to associate the policy with.

This parameter allows (through its regex pattern ) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Parameters:

users - The name of the user to associate the policy with. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-policy.html#cfn-iam-policy-users

build

@Stability(Stable)
public CfnPolicyPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnPolicyPropsMixin.