CanonicalUserPrincipal

class aws_cdk.aws_iam.CanonicalUserPrincipal(canonical_user_id)

Bases: aws_cdk.aws_iam.PrincipalBase

A policy prinicipal for canonicalUserIds - useful for S3 bucket policies that use Origin Access identities.

See https://docs.aws.amazon.com/general/latest/gr/acct-identifiers.html

and

https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-restricting-access-to-s3.html

for more details.

__init__(canonical_user_id)

Parameters

canonical_user_id (str) –

Return type

None

Methods

add_to_policy(_statement)

Add to the policy of this principal.

Parameters

_statement (PolicyStatement) –

Return type

bool

to_json()

JSON-ify the principal.

Used when JSON.stringify() is called

Return type

Mapping[str, List[str]]

to_string()

Returns a string representation of an object.

Return type

str

with_conditions(conditions)

Returns a new PrincipalWithConditions using this principal as the base, with the passed conditions added.

When there is a value for the same operator and key in both the principal and the conditions parameter, the value from the conditions parameter will be used.

Parameters

conditions (Mapping[str, Mapping[str, Any]]) –

return :rtype: IPrincipal :return: a new PrincipalWithConditions object.

Attributes

assume_role_action

When this Principal is used in an AssumeRole policy, the action to use.

Return type

str

canonical_user_id

Return type

str

grant_principal

The principal to grant permissions to.

Return type

IPrincipal

policy_fragment

Return the policy fragment that identifies this principal in a Policy.

Return type

PrincipalPolicyFragment