Package software.amazon.awscdk.services.iam

Interface CfnPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:17.749Z")
@Stability(Stable)
public interface CfnPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnPolicy.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.iam.*;
 Object policyDocument;
 CfnPolicyProps cfnPolicyProps = CfnPolicyProps.builder()
         .policyDocument(policyDocument)
         .policyName("policyName")
         // the properties below are optional
         .groups(List.of("groups"))
         .roles(List.of("roles"))
         .users(List.of("users"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnPolicyProps.Builder	builder()
default List<String>	getGroups()	The name of the group to associate the policy with.
Object	getPolicyDocument()	The policy document.
String	getPolicyName()	The name of the policy document.
default List<String>	getRoles()	The name of the role to associate the policy with.
default List<String>	getUsers()	The name of the user to associate the policy with.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getPolicyDocument

@Stability(Stable)
@NotNull
Object getPolicyDocument()

The policy document.

You must provide policies in JSON format in IAM. However, for AWS CloudFormation templates formatted in YAML, you can provide the policy in JSON or YAML format. AWS 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 ( )

See Also:

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

getPolicyName

@Stability(Stable)
@NotNull
String getPolicyName()

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: _+=,.@-

See Also:

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

getGroups

@Stability(Stable)
@Nullable
default List<String> getGroups()

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: _+=,.@-.

See Also:

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

getRoles

@Stability(Stable)
@Nullable
default List<String> getRoles()

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 AWS CloudFormation deletes the AWS::ECS::Service resource before deleting its role's policy.

See Also:

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

getUsers

@Stability(Stable)
@Nullable
default List<String> getUsers()

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: _+=,.@-

See Also:

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

builder

@Stability(Stable)
static CfnPolicyProps.Builder builder()

Returns:

a CfnPolicyProps.Builder of CfnPolicyProps