Skip to content

OIDCProvider

This class encapsulates and extends the ROS resource type ALIYUN::RAM::OIDCProvider.

Initializers

import com.aliyun.ros.cdk.ram.OIDCProvider;
OIDCProvider.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .fingerprints(IResolvable)
    .fingerprints(java.util.List<java.lang.String)
    .fingerprints(IResolvable>)
    .issuerUrl(java.lang.String)
    .issuerUrl(IResolvable)
    .oidcProviderName(java.lang.String)
    .oidcProviderName(IResolvable)
//  .clientIds(IResolvable)
//  .clientIds(java.util.List<java.lang.String)
//  .clientIds(IResolvable>)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .issuanceLimitTime(java.lang.Number)
//  .issuanceLimitTime(IResolvable)
    .build();
Name Type Description
scope com.aliyun.ros.cdk.core.Construct No description.
id java.lang.String No description.
enableResourcePropertyConstraint java.lang.Boolean No description.
fingerprints com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property fingerprints: The list of the fingerprints, max length is 5.
issuerUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property issuerUrl: The URL of the issuer, which is provided by the external IdP.
oidcProviderName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property oidcProviderName: The name of the OIDC IdP.
clientIds com.aliyun.ros.cdk.core.IResolvable OR java.util.List Property clientIds: The ID of the client, which is provided by the external IdP.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the OIDC IdP.
issuanceLimitTime java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property issuanceLimitTime: The earliest time when an external IdP can issue an ID token.

scopeRequired

  • Type: com.aliyun.ros.cdk.core.Construct

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

fingerprintsRequired

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property fingerprints: The list of the fingerprints, max length is 5.


issuerUrlRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property issuerUrl: The URL of the issuer, which is provided by the external IdP.

The URL of the issuer must be unique within an Alibaba Cloud account. The URL of the issuer must start with https and be in the valid URL format. The URL cannot contain query parameters that follow a question mark (?) or logon information that is identified by at signs (@). The URL cannot be a fragment URL that contains number signs (#). The URL can be up to 255 characters in length.


oidcProviderNameRequired

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property oidcProviderName: The name of the OIDC IdP.

The name can contain letters, digits, and special characters and cannot start or end with the special characters. The special characters are periods, (.), hyphens (-), and underscores (_).`` The name can be up to 128 characters in length.


clientIdsOptional

  • Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.List

Property clientIds: The ID of the client, which is provided by the external IdP.

If you want to specify multiple client IDs, separate the client IDs with commas (,). The client ID can contain letters, digits, and special characters and cannot start with the special characters. The special characters are periods (.), hyphens (-), underscores (_), colons (:), and forward slashes (\/).`` The client ID can be up to 128 characters in length.


descriptionOptional

  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: The description of the OIDC IdP.

The description can be up to 256 characters in length.


issuanceLimitTimeOptional

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property issuanceLimitTime: The earliest time when an external IdP can issue an ID token.

If the value of the iat field in the ID token is later than the current time, the request is rejected. Unit: hours. Valid values: 1 to 168.


Methods

Name Description
toString Returns a string representation of this construct.
synthesize Allows this construct to emit artifacts into the cloud assembly during synthesis.
addCondition No description.
addCount No description.
addDependency No description.
addResourceDesc No description.
applyRemovalPolicy No description.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc No description.
getAtt No description.
setMetadata No description.

toString

public java.lang.String toString()

Returns a string representation of this construct.

synthesize

public void synthesize(ISynthesisSession session)

Allows this construct to emit artifacts into the cloud assembly during synthesis.

This method is usually implemented by framework-level constructs such as Stack and Asset as they participate in synthesizing the cloud assembly.

sessionRequired

  • Type: com.aliyun.ros.cdk.core.ISynthesisSession

The synthesis session.


addCondition

public void addCondition(RosCondition condition)

conditionRequired

  • Type: com.aliyun.ros.cdk.core.RosCondition

addCount

public void addCount(java.lang.Number OR IResolvable count)

countRequired

  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

addDependency

public void addDependency(Resource resource)

resourceRequired

  • Type: com.aliyun.ros.cdk.core.Resource

addResourceDesc

public void addResourceDesc(java.lang.String desc)

descRequired

  • Type: java.lang.String

applyRemovalPolicy

public void applyRemovalPolicy(RemovalPolicy policy)

policyRequired

  • Type: com.aliyun.ros.cdk.core.RemovalPolicy

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

getAtt

public IResolvable getAtt(java.lang.String name)

nameRequired

  • Type: java.lang.String

setMetadata

public void setMetadata(java.lang.String key, java.lang.Object value)

keyRequired

  • Type: java.lang.String

valueRequired

  • Type: java.lang.Object

Static Functions

Name Description
isConstruct Return whether the given object is a Construct.

isConstruct

import com.aliyun.ros.cdk.ram.OIDCProvider;
OIDCProvider.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

xRequired

  • Type: java.lang.Object

Properties

Name Type Description
node com.aliyun.ros.cdk.core.ConstructNode The construct tree node associated with this construct.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
ref java.lang.String No description.
stack com.aliyun.ros.cdk.core.Stack The stack in which this resource is defined.
resource com.aliyun.ros.cdk.core.RosResource No description.
attrOidcProviderName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute OIDCProviderName: The name of the OIDC IdP.
props OIDCProviderProps No description.

nodeRequired

public ConstructNode getNode();
  • Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.ros.cdk.core.IResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.


refRequired

public java.lang.String getRef();
  • Type: java.lang.String

stackRequired

public Stack getStack();
  • Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.


resourceOptional

public RosResource getResource();
  • Type: com.aliyun.ros.cdk.core.RosResource

attrOidcProviderNameRequired

public java.lang.Object getAttrOidcProviderName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute OIDCProviderName: The name of the OIDC IdP.

The name can contain letters, digits, and special characters and cannot start or end with the special characters. The special characters are periods, (.), hyphens (-), and underscores (_).`` The name can be up to 128 characters in length.


propsRequired

public OIDCProviderProps getProps();