aws-cdk-lib.aws_iam.CfnUserPolicyProps

CfnUserPolicyProps Struct

Properties for defining a CfnUserPolicy.

Source

Generated code

Type last changed

v2.89.0 · 28 Jul 2023

Example

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

declare const policyDocument: any;
const cfnUserPolicyProps: iam.CfnUserPolicyProps = {
  policyName: 'policyName',
  userName: 'userName',

  // the properties below are optional
  policyDocument: policyDocument,
};

Properties

policyDocumentanypolicy_documentAnypolicyDocumentObjectPolicyDocumentobjectPolicyDocumentinterface{}#

The policy document.

notes

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 )

policyNamestringpolicy_namestrpolicyNameStringPolicyNamestringPolicyName*stringrequired#

The name of the policy document.

notes

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

userNamestringuser_namestruserNameStringUserNamestringUserName*stringrequired#

The name of the user to associate the policy with.

notes

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

Used as props by

• CfnUserPolicy