2.233.0

interface CfnPolicyMixinProps

LanguageType name
.NETAmazon.CDK.Mixins.Preview.AWS.IAM.Mixins.CfnPolicyMixinProps
Gogithub.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiam/mixins#CfnPolicyMixinProps
Javasoftware.amazon.awscdk.mixins.preview.services.iam.mixins.CfnPolicyMixinProps
Pythonaws_cdk.mixins_preview.aws_iam.mixins.CfnPolicyMixinProps
TypeScript @aws-cdk/mixins-preview » aws_iam » mixins » CfnPolicyMixinProps

Properties for CfnPolicyPropsMixin.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as iam_mixins } from '@aws-cdk/mixins-preview/aws-iam';

declare const policyDocument: any;
const cfnPolicyMixinProps: iam_mixins.CfnPolicyMixinProps = {
  groups: ['groups'],
  policyDocument: policyDocument,
  policyName: 'policyName',
  roles: ['roles'],
  users: ['users'],
};

Properties

NameTypeDescription
groups?string[]The name of the group to associate the policy with.
policyDocument?anyThe policy document.
policyName?stringThe name of the policy document.
roles?string[]The name of the role to associate the policy with.
users?string[]The name of the user to associate the policy with.

groups?

Type: string[] (optional)

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

policyDocument?

Type: any (optional)

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 ( \u0020 ) through the end of the ASCII character range
  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF )
  • The special characters tab ( \u0009 ), line feed ( \u000A ), and carriage return ( \u000D )

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

policyName?

Type: string (optional)

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

roles?

Type: string[] (optional)

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.

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

users?

Type: string[] (optional)

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

← PreviousNext →