Interface CfnPolicyProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnPolicyProps.Jsii$Proxy
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:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnPolicyProps
static final class
An implementation forCfnPolicyProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnPolicyProps.Builder
builder()
The name of the group to associate the policy with.The policy document.The name of the policy document.getRoles()
The name of the role to associate the policy with.getUsers()
The name of the user to associate the policy with.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
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 (
- The printable characters in the Basic Latin and Latin-1 Supplement character set (through
ΓΏ
) - The special characters tab (
- See Also:
- Any printable ASCII character ranging from the space character (
-
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:
-
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:
-
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
orAWS::IAM::ManagedPolicy
) has aRef
to a role and if a resource (such asAWS::ECS::Service
) also has aRef
to the same role, add aDependsOn
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 anAWS::ECS::Service
resource, theDependsOn
attribute ensures that AWS CloudFormation deletes theAWS::ECS::Service
resource before deleting its role's policy.- See Also:
-
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:
-
builder
- Returns:
- a
CfnPolicyProps.Builder
ofCfnPolicyProps
-