CfnOIDCProviderPropsMixin

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

Bases: Mixin

Creates or updates an IAM entity to describe an identity provider (IdP) that supports OpenID Connect (OIDC) .

The OIDC provider that you create with this operation can be used as a principal in a role’s trust policy. Such a policy establishes a trust relationship between AWS and the OIDC provider.

When you create the IAM OIDC provider, you specify the following:

The URL of the OIDC identity provider (IdP) to trust
A list of client IDs (also known as audiences) that identify the application or applications that are allowed to authenticate using the OIDC provider
A list of tags that are attached to the specified IAM OIDC provider
A list of thumbprints of one or more server certificates that the IdP uses

You get all of this information from the OIDC IdP that you want to use to access AWS .

When you update the IAM OIDC provider, you specify the following:

The URL of the OIDC identity provider (IdP) to trust
A list of client IDs (also known as audiences) that replaces the existing list of client IDs associated with the OIDC IdP
A list of tags that replaces the existing list of tags attached to the specified IAM OIDC provider
A list of thumbprints that replaces the existing list of server certificates thumbprints that the IdP uses

The trust for the OIDC provider is derived from the IAM provider that this operation creates. Therefore, it is best to limit access to the CreateOpenIDConnectProvider operation to highly privileged users.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html
CloudformationResource:: AWS::IAM::OIDCProvider
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_oIDCProvider_props_mixin = iam_mixins.CfnOIDCProviderPropsMixin(iam_mixins.CfnOIDCProviderMixinProps(
    client_id_list=["clientIdList"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    thumbprint_list=["thumbprintList"],
    url="url"
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

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

Parameters:

props (Union[CfnOIDCProviderMixinProps, 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 = ['clientIdList', 'tags', 'thumbprintList', 'url']

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