WebIdentityPrincipal
- class aws_cdk.aws_iam.WebIdentityPrincipal(identity_provider, conditions=None)
Bases:
FederatedPrincipal
A principal that represents a federated identity provider as Web Identity such as Cognito, Amazon, Facebook, Google, etc.
- ExampleMetadata:
infused
Example:
principal = iam.WebIdentityPrincipal("cognito-identity.amazonaws.com", { "StringEquals": {"cognito-identity.amazonaws.com:aud": "us-east-2:12345678-abcd-abcd-abcd-123456"}, "ForAnyValue:StringLike": {"cognito-identity.amazonaws.com:amr": "unauthenticated"} })
- Parameters:
identity_provider (
str
) – identity provider (i.e. ‘cognito-identity.amazonaws.com’ for users authenticated through Cognito).conditions (
Optional
[Mapping
[str
,Any
]]) – The conditions under which the policy is in effect. See the IAM documentation.
Methods
- add_to_assume_role_policy(document)
Add the principal to the AssumeRolePolicyDocument.
Add the statements to the AssumeRolePolicyDocument necessary to give this principal permissions to assume the given role.
- Parameters:
document (
PolicyDocument
) –- Return type:
None
- add_to_policy(statement)
Add to the policy of this principal.
- Parameters:
statement (
PolicyStatement
) –- Return type:
bool
- add_to_principal_policy(_statement)
Add to the policy of this principal.
- Parameters:
_statement (
PolicyStatement
) –- Return type:
- dedupe_string()
Return whether or not this principal is equal to the given principal.
- Return type:
Optional
[str
]
- 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
,Any
]) –- Return type:
- Returns:
a new PrincipalWithConditions object.
- with_session_tags()
Returns a new principal using this principal as the base, with session tags enabled.
- Return type:
- Returns:
a new SessionTagsPrincipal object.
Attributes
- assume_role_action
When this Principal is used in an AssumeRole policy, the action to use.
- conditions
The conditions under which the policy is in effect.
- federated
federated identity provider (i.e. ‘cognito-identity.amazonaws.com’ for users authenticated through Cognito).
- grant_principal
The principal to grant permissions to.
- policy_fragment
Return the policy fragment that identifies this principal in a Policy.
- principal_account
The AWS account ID of this principal.
Can be undefined when the account is not known (for example, for service principals). Can be a Token - in that case, it’s assumed to be AWS::AccountId.