CfnSAMLProviderPropsMixin

class aws_cdk.mixins_preview.aws_iam.mixins.CfnSAMLProviderPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an IAM resource that describes an identity provider (IdP) that supports SAML 2.0.

The SAML provider resource that you create with this operation can be used as a principal in an IAM role’s trust policy. Such a policy can enable federated users who sign in using the SAML IdP to assume the role. You can create an IAM role that supports Web-based single sign-on (SSO) to the the console or one that supports API access to AWS .

When you create the SAML provider resource, you upload a SAML metadata document that you get from your IdP. That document includes the issuer’s name, expiration information, and keys that can be used to validate the SAML authentication response (assertions) that the IdP sends. You must generate the metadata document using the identity management software that is used as your organization’s IdP. .. epigraph:

This operation requires `Signature Version 4 <https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html>`_ .

For more information, see Enabling SAML 2.0 federated users to access the the console and About SAML 2.0-based federation in the IAM User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-samlprovider.html
CloudformationResource:: AWS::IAM::SAMLProvider
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_iam import mixins as iam_mixins

cfn_sAMLProvider_props_mixin = iam_mixins.CfnSAMLProviderPropsMixin(iam_mixins.CfnSAMLProviderMixinProps(
    add_private_key="addPrivateKey",
    assertion_encryption_mode="assertionEncryptionMode",
    name="name",
    private_key_list=[iam_mixins.CfnSAMLProviderPropsMixin.SAMLPrivateKeyProperty(
        key_id="keyId",
        timestamp="timestamp"
    )],
    remove_private_key="removePrivateKey",
    saml_metadata_document="samlMetadataDocument",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::IAM::SAMLProvider.

Parameters:

props (Union[CfnSAMLProviderMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['addPrivateKey', 'assertionEncryptionMode', 'name', 'privateKeyList', 'removePrivateKey', 'samlMetadataDocument', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

SAMLPrivateKeyProperty

class CfnSAMLProviderPropsMixin.SAMLPrivateKeyProperty(*, key_id=None, timestamp=None)

Bases: object

Contains the private keys for the SAML provider.

This data type is used as a response element in the GetSAMLProvider operation.

Parameters:

key_id (Optional[str]) – The unique identifier for the SAML private key.
timestamp (Optional[str]) – The date and time, in ISO 8601 date-time format, when the private key was uploaded.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-samlprovider-samlprivatekey.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_iam import mixins as iam_mixins

s_aMLPrivate_key_property = iam_mixins.CfnSAMLProviderPropsMixin.SAMLPrivateKeyProperty(
    key_id="keyId",
    timestamp="timestamp"
)

Attributes

key_id

The unique identifier for the SAML private key.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-samlprovider-samlprivatekey.html#cfn-iam-samlprovider-samlprivatekey-keyid

timestamp

The date and time, in ISO 8601 date-time format, when the private key was uploaded.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-samlprovider-samlprivatekey.html#cfn-iam-samlprovider-samlprivatekey-timestamp