Policy L2 construct
The AWS::IAM::Policy resource associates an inline IAM policy with IAM users, roles, or groups. For more information about IAM policies, see Overview of IAM Policies in the IAM User Guide guide.
Example
declare const postAuthFn: lambda.Function;
const userpool = new cognito.UserPool(this, 'myuserpool', {
lambdaTriggers: {
postAuthentication: postAuthFn,
},
});
// provide permissions to describe the user pool scoped to the ARN the user pool
postAuthFn.role?.attachInlinePolicy(new iam.Policy(this, 'userpool-policy', {
statements: [new iam.PolicyStatement({
actions: ['cognito-idp:DescribeUserPool'],
resources: [userpool.userPoolArn],
})],
}));
# post_auth_fn: lambda.Function
userpool = cognito.UserPool(self, "myuserpool",
lambda_triggers=cognito.UserPoolTriggers(
post_authentication=post_auth_fn
)
)
# provide permissions to describe the user pool scoped to the ARN the user pool
post_auth_fn.role.attach_inline_policy(iam.Policy(self, "userpool-policy",
statements=[iam.PolicyStatement(
actions=["cognito-idp:DescribeUserPool"],
resources=[userpool.user_pool_arn]
)]
))
Function postAuthFn;
UserPool userpool = UserPool.Builder.create(this, "myuserpool")
.lambdaTriggers(UserPoolTriggers.builder()
.postAuthentication(postAuthFn)
.build())
.build();
// provide permissions to describe the user pool scoped to the ARN the user pool
postAuthFn.role.attachInlinePolicy(Policy.Builder.create(this, "userpool-policy")
.statements(List.of(PolicyStatement.Builder.create()
.actions(List.of("cognito-idp:DescribeUserPool"))
.resources(List.of(userpool.getUserPoolArn()))
.build()))
.build());
// Install: dotnet add package Amazon.CDK.Lib
Function postAuthFn;
var userpool = new UserPool(this, "myuserpool", new UserPoolProps {
LambdaTriggers = new UserPoolTriggers {
PostAuthentication = postAuthFn
}
});
// provide permissions to describe the user pool scoped to the ARN the user pool
postAuthFn.Role.AttachInlinePolicy(new Policy(this, "userpool-policy", new PolicyProps {
Statements = new [] { new PolicyStatement(new PolicyStatementProps {
Actions = new [] { "cognito-idp:DescribeUserPool" },
Resources = new [] { userpool.UserPoolArn }
}) }
}));
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
var postAuthFn Function
userpool := cognito.NewUserPool(this, jsii.String("myuserpool"), &UserPoolProps{
LambdaTriggers: &UserPoolTriggers{
PostAuthentication: postAuthFn,
},
})
// provide permissions to describe the user pool scoped to the ARN the user pool
postAuthFn.Role.AttachInlinePolicy(iam.NewPolicy(this, jsii.String("userpool-policy"), &PolicyProps{
Statements: []PolicyStatement{
iam.NewPolicyStatement(&PolicyStatementProps{
Actions: []*string{
jsii.String("cognito-idp:DescribeUserPool"),
},
Resources: []*string{
userpool.UserPoolArn,
},
}),
},
}))
Initializer
new Policy(scope: Construct, id: string, props?: PolicyProps)
Policy(scope: Construct, id: str, props: typing.Optional[PolicyProps] = None)
new Policy(Construct scope, String id, PolicyProps props)
new Policy(Construct scope, string id, PolicyProps? props = null)
NewPolicy(Scope Construct, Id *string, Props PolicyProps)
Construct Props
documentPolicyDocumentdocumentPolicyDocumentdocumentPolicyDocumentDocumentPolicyDocumentDocumentPolicyDocument#Default: An empty policy.
If omited, any PolicyStatement provided in the statements property will be applied against the empty default PolicyDocument.
notes
Unless set to true, this Policy construct will not materialize to an AWS::IAM::Policy CloudFormation resource in case it would have no effect (for example, if it remains unattached to an IAM identity or if it has no statements). This is generally desired behavior, since it prevents creating invalid--and hence undeployable--CloudFormation templates.
In cases where you know the policy must be created and it is actually an error if no statements have been added to it or it remains unattached to an IAM identity, you can set this to true.
Default: No groups.
You can also use attachToGroup(group) to attach this policy to a group.
Default: Uses the logical ID of the policy resource, which is ensured to be unique within the stack.
If you specify multiple policies for an entity, specify unique names. For example, if you specify a list of policies for an IAM role, each policy must have a unique name.
Default: No roles.
You can also use attachToRole(role) to attach this policy to a role.
statementsPolicyStatement[]statementstyping.List[PolicyStatement]statementsList<PolicyStatement>StatementsPolicyStatement[]Statements*[]PolicyStatement#Default: No statements.
You can also use addStatements(...statement) to add permissions later.
Properties
documentPolicyDocumentdocumentPolicyDocumentdocumentPolicyDocumentDocumentPolicyDocumentDocumentPolicyDocumentrequired#envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#policyRefPolicyReferencepolicy_refPolicyReferencepolicyRefPolicyReferencePolicyRefPolicyReferencePolicyRefPolicyReferencerequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Methods
addStatements(...statement: PolicyStatement[]): voiddef add_statements(self, statement: PolicyStatement) -> Nonepublic void addStatements(PolicyStatement statement)public void AddStatements(PolicyStatement statement)func AddStatements(Statement PolicyStatement)#applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#notes
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).
attachToGroup(group: IGroup): voiddef attach_to_group(self, group: IGroup) -> Nonepublic void attachToGroup(IGroup group)public void AttachToGroup(IGroup group)func AttachToGroup(Group IGroup)#attachToRole(role: IRole): voiddef attach_to_role(self, role: IRole) -> Nonepublic void attachToRole(IRole role)public void AttachToRole(IRole role)func AttachToRole(Role IRole)#attachToUser(user: IUser): voiddef attach_to_user(self, user: IUser) -> Nonepublic void attachToUser(IUser user)public void AttachToUser(IUser user)func AttachToUser(User IUser)#fromPolicyName(scope: Construct, id: string, policyName: string): IPolicy@staticmethod def from_policy_name(scope: Construct, id: str, policy_name: str) -> IPolicypublic static IPolicy fromPolicyName(Construct scope, String id, String policyName)public static IPolicy FromPolicyName(Construct scope, string id, string policyName)func FromPolicyName(Scope Construct, Id *string, PolicyName *string) IPolicystatic#isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.