class CfnOIDCProviderPropsMixin

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.IAM.Mixins.CfnOIDCProviderPropsMixin
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsiam/mixins#CfnOIDCProviderPropsMixin
Java	software.amazon.awscdk.mixins.preview.services.iam.mixins.CfnOIDCProviderPropsMixin
Python	aws_cdk.mixins_preview.aws_iam.mixins.CfnOIDCProviderPropsMixin
TypeScript	@aws-cdk/mixins-preview » aws_iam » mixins » CfnOIDCProviderPropsMixin

Implements IMixin

Extends 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 also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-oidcprovider.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins } from '@aws-cdk/mixins-preview';
import { mixins as iam_mixins } from '@aws-cdk/mixins-preview/aws-iam';
const cfnOIDCProviderPropsMixin = new iam_mixins.CfnOIDCProviderPropsMixin({
  clientIdList: ['clientIdList'],
  tags: [{
    key: 'key',
    value: 'value',
  }],
  thumbprintList: ['thumbprintList'],
  url: 'url',
}, /* all optional props */ {
  strategy: mixins.PropertyMergeStrategy.OVERRIDE,
});

Initializer

new CfnOIDCProviderPropsMixin(props: CfnOIDCProviderMixinProps, options?: CfnPropertyMixinOptions)

Parameters

• props CfnOIDCProviderMixinProps — L1 properties to apply.
• options CfnPropertyMixinOptions — Mixin options.

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

Properties

Name	Type	Description
props	CfnOIDCProviderMixinProps
strategy	PropertyMergeStrategy
static CFN_PROPERTY_KEYS	string[]

---

props

Type: CfnOIDCProviderMixinProps

---

strategy

Type: PropertyMergeStrategy

---

static CFN_PROPERTY_KEYS

Type: string[]

Methods

Name	Description
applyTo(construct)	Apply the mixin properties to the construct.
supports(construct)	Check if this mixin supports the given construct.

---

applyTo(construct)

public applyTo(construct: IConstruct): IConstruct

Parameters

• construct IConstruct

Returns

• IConstruct

Apply the mixin properties to the construct.

---

supports(construct)

public supports(construct: IConstruct): boolean

Parameters

• construct IConstruct

Returns

• boolean

Check if this mixin supports the given construct.