SamlPrincipal¶
-
class
aws_cdk.aws_iam.
SamlPrincipal
(saml_provider, conditions)¶ Bases:
aws_cdk.aws_iam.FederatedPrincipal
Principal entity that represents a SAML federated identity provider.
- ExampleMetadata
infused
Example:
provider = iam.SamlProvider(self, "Provider", metadata_document=iam.SamlMetadataDocument.from_file("/path/to/saml-metadata-document.xml") ) principal = iam.SamlPrincipal(provider, { "StringEquals": { "SAML:iss": "issuer" } })
- Parameters
saml_provider (
ISamlProvider
) –conditions (
Mapping
[str
,Any
]) –
Methods
-
add_to_assume_role_policy
(document)¶ Add the princpial 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.
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.
- Return type
str
-
conditions
¶ The conditions under which the policy is in effect.
- Return type
Mapping
[str
,Any
]
-
federated
¶ federated identity provider (i.e. ‘cognito-identity.amazonaws.com’ for users authenticated through Cognito).
- Return type
str
-
grant_principal
¶ The principal to grant permissions to.
- Return type
-
policy_fragment
¶ Return the policy fragment that identifies this principal in a Policy.
- Return type
-
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.
- Return type
Optional
[str
]