OIDCProvider

• Implements: IOIDCProvider

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

Initializers

import ros_cdk_ram
ros_cdk_ram.OIDCProvider(
  scope: Construct,
  id: str,
  fingerprints: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]],
  issuer_url: typing.Union[str, IResolvable],
  oidc_provider_name: typing.Union[str, IResolvable],
  client_ids: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  description: typing.Union[str, IResolvable] = None,
  issuance_limit_time: typing.Union[typing.Union[int, float], IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

scope^Required

• Type: ros_cdk_core.Construct

id^Required

• Type: str

fingerprints^Required

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

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

issuer_url^Required

• Type: typing.Union[str, 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.

oidc_provider_name^Required

• Type: typing.Union[str, 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.

client_ids^Optional

• Type: typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]

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.

description^Optional

• Type: typing.Union[str, ros_cdk_core.IResolvable]

Property description: The description of the OIDC IdP.

The description can be up to 256 characters in length.

issuance_limit_time^Optional

• Type: typing.Union[typing.Union[int, float], 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.

enable_resource_property_constraint^Optional

• Type: bool

Methods

to_string

def to_string() -> str

Returns a string representation of this construct.

synthesize

def synthesize(
  session: ISynthesisSession
) -> None

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.

session^Required

• Type: ros_cdk_core.ISynthesisSession

The synthesis session.

add_condition

def add_condition(
  condition: RosCondition
) -> None

condition^Required

• Type: ros_cdk_core.RosCondition

add_count

def add_count(
  count: typing.Union[typing.Union[int, float], IResolvable]
) -> None

count^Required

• Type: typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]

add_dependency

def add_dependency(
  resource: Resource
) -> None

resource^Required

• Type: ros_cdk_core.Resource

add_resource_desc

def add_resource_desc(
  desc: str
) -> None

desc^Required

• Type: str

apply_removal_policy

def apply_removal_policy(
  policy: RemovalPolicy
) -> None

policy^Required

• Type: ros_cdk_core.RemovalPolicy

fetch_condition

def fetch_condition() -> RosCondition

fetch_dependency

def fetch_dependency() -> typing.List[str]

fetch_resource_desc

def fetch_resource_desc() -> str

get_att

def get_att(
  name: str
) -> IResolvable

name^Required

• Type: str

set_metadata

def set_metadata(
  key: str,
  value: typing.Any
) -> None

key^Required

• Type: str

value^Required

• Type: typing.Any

Static Functions

is_construct

import ros_cdk_ram
ros_cdk_ram.OIDCProvider.is_construct(
  x: typing.Any
)

Return whether the given object is a Construct.

x^Required

• Type: typing.Any

Properties

node^Required

node: ConstructNode

• Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

env^Required

env: IResourceEnvironment

• Type: 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.

ref^Required

ref: str

• Type: str

stack^Required

stack: Stack

• Type: ros_cdk_core.Stack

The stack in which this resource is defined.

resource^Optional

resource: RosResource

• Type: ros_cdk_core.RosResource

attr_oidc_provider_name^Required

attr_oidc_provider_name: typing.Union[str, IResolvable]

• Type: typing.Union[str, 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.

props^Required

props: OIDCProviderProps

• Type: OIDCProviderProps