Interface ICfnUserPolicyProps

Properties for defining a CfnUserPolicy.

Namespace: Amazon.CDK.AWS.IAM

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnUserPolicyProps

Syntax (vb)

Public Interface ICfnUserPolicyProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IAM;

var policyDocument;

var cfnUserPolicyProps = new CfnUserPolicyProps {
    PolicyName = "policyName",
    UserName = "userName",

    // the properties below are optional
    PolicyDocument = policyDocument
};

Synopsis

Properties

PolicyDocument	The policy document.
PolicyName	The name of the policy document.
UserName	The name of the user to associate the policy with.

Properties

PolicyDocument

The policy document.

virtual object PolicyDocument { get; }

Property Value

System.Object

Remarks

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:

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

PolicyName

The name of the policy document.

string PolicyName { get; }

Property Value

System.String

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-userpolicy.html#cfn-iam-userpolicy-policyname

UserName

The name of the user to associate the policy with.

string UserName { get; }

Property Value

System.String

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-userpolicy.html#cfn-iam-userpolicy-username