84 lines
3.3 KiB
TypeScript
84 lines
3.3 KiB
TypeScript
import type { Construct } from 'constructs';
|
|
import type { RemovalPolicy } from '../..';
|
|
import * as iam from '../../aws-iam';
|
|
/**
|
|
* Initialization properties for `OpenIdConnectProvider`.
|
|
*/
|
|
export interface OpenIdConnectProviderProps {
|
|
/**
|
|
* The URL of the identity provider. The URL must begin with https:// and
|
|
* should correspond to the iss claim in the provider's OpenID Connect ID
|
|
* tokens. Per the OIDC standard, path components are allowed but query
|
|
* parameters are not. Typically the URL consists of only a hostname, like
|
|
* https://server.example.org or https://example.com.
|
|
*
|
|
* You can find your OIDC Issuer URL by:
|
|
* aws eks describe-cluster --name %cluster_name% --query "cluster.identity.oidc.issuer" --output text
|
|
*/
|
|
readonly url: string;
|
|
/**
|
|
* The removal policy to apply to the OpenID Connect Provider
|
|
*
|
|
* @default - RemovalPolicy.DESTROY
|
|
*/
|
|
readonly removalPolicy?: RemovalPolicy;
|
|
}
|
|
/**
|
|
* Initialization properties for `OidcProviderNative`.
|
|
*/
|
|
export interface OidcProviderNativeProps extends OpenIdConnectProviderProps {
|
|
}
|
|
/**
|
|
* IAM OIDC identity providers are entities in IAM that describe an external
|
|
* identity provider (IdP) service that supports the OpenID Connect (OIDC)
|
|
* standard, such as Google or Salesforce. You use an IAM OIDC identity provider
|
|
* when you want to establish trust between an OIDC-compatible IdP and your AWS
|
|
* account.
|
|
*
|
|
* This implementation has default values for thumbprints and clientIds props
|
|
* that will be compatible with the eks cluster
|
|
*
|
|
* @see http://openid.net/connect
|
|
* @see https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html
|
|
*
|
|
* @resource AWS::CloudFormation::CustomResource
|
|
* @deprecated Use `OidcProviderNative` instead. This construct will be removed in a future major release.
|
|
*/
|
|
export declare class OpenIdConnectProvider extends iam.OpenIdConnectProvider {
|
|
/** Uniquely identifies this class. */
|
|
static readonly PROPERTY_INJECTION_ID: string;
|
|
/**
|
|
* Defines an OpenID Connect provider.
|
|
* @param scope The definition scope
|
|
* @param id Construct ID
|
|
* @param props Initialization properties
|
|
*/
|
|
constructor(scope: Construct, id: string, props: OpenIdConnectProviderProps);
|
|
}
|
|
/**
|
|
* IAM OIDC identity providers are entities in IAM that describe an external
|
|
* identity provider (IdP) service that supports the OpenID Connect (OIDC)
|
|
* standard, such as Google or Salesforce. You use an IAM OIDC identity provider
|
|
* when you want to establish trust between an OIDC-compatible IdP and your AWS
|
|
* account.
|
|
*
|
|
* This implementation uses the native CloudFormation resource and has default
|
|
* values for thumbprints and clientIds props that will be compatible with the eks cluster.
|
|
*
|
|
* @see http://openid.net/connect
|
|
* @see https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_oidc.html
|
|
*
|
|
* @resource AWS::IAM::OIDCProvider
|
|
*/
|
|
export declare class OidcProviderNative extends iam.OidcProviderNative {
|
|
/** Uniquely identifies this class. */
|
|
static readonly PROPERTY_INJECTION_ID: string;
|
|
/**
|
|
* Defines a native OpenID Connect provider.
|
|
* @param scope The definition scope
|
|
* @param id Construct ID
|
|
* @param props Initialization properties
|
|
*/
|
|
constructor(scope: Construct, id: string, props: OidcProviderNativeProps);
|
|
}
|