Application

This class encapsulates and extends the ROS resource type ALIYUN::RAM::Application, which is used to create an application.

Initializers

import ros_cdk_ram
ros_cdk_ram.Application(
  scope: Construct,
  id: str,
  app_name: typing.Union[str, IResolvable],
  app_type: typing.Union[str, IResolvable],
  display_name: typing.Union[str, IResolvable],
  access_token_validity: typing.Union[typing.Union[int, float], IResolvable] = None,
  is_multi_tenant: typing.Union[bool, IResolvable] = None,
  predefined_scopes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  redirect_uris: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  refresh_token_validity: typing.Union[typing.Union[int, float], IResolvable] = None,
  required_scopes: typing.Union[IResolvable, typing.List[typing.Union[str, IResolvable]]] = None,
  secret_required: typing.Union[bool, IResolvable] = None,
  enable_resource_property_constraint: bool = None
)

Name	Type	Description
`scope`	`ros_cdk_core.Construct`	No description.
`id`	`str`	No description.
`app_name`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property appName: The name of the application.
`app_type`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property appType: The type of the application.
`display_name`	`typing.Union[str, ros_cdk_core.IResolvable]`	Property displayName: The display name of the application.
`access_token_validity`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property accessTokenValidity: The validity period of the access token.
`is_multi_tenant`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property isMultiTenant: Indicates whether the application can be installed by using other Alibaba Cloud accounts.
`predefined_scopes`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property predefinedScopes: List of the scopes of application permissions.
`redirect_uris`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property redirectUris: List of the callback URLs.
`refresh_token_validity`	`typing.Union[typing.Union[int, float], ros_cdk_core.IResolvable]`	Property refreshTokenValidity: The validity period of the refreshed token.
`required_scopes`	`typing.Union[ros_cdk_core.IResolvable, typing.List[typing.Union[str, ros_cdk_core.IResolvable]]]`	Property requiredScopes: Required scope of application permissions.
`secret_required`	`typing.Union[bool, ros_cdk_core.IResolvable]`	Property secretRequired: Indicates whether a secret is required.
`enable_resource_property_constraint`	`bool`	No description.

`scope`^Required

Type: ros_cdk_core.Construct

`id`^Required

Type: str

`app_name`^Required

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

Property appName: The name of the application.

The name can be up to 64 characters in length. The name can contain letters, digits, periods (.), underscores (_), and hyphens (-).

`app_type`^Required

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

Property appType: The type of the application.

Valid values:

WebApp: a web application that interacts with a browser.
NativeApp: a native application that runs on an operating system, such as a desktop operating system or a mobile operating system.
ServerApp: an application that accesses Alibaba Cloud services without the need of manual user logon. User provisioning is automated based on the System for Cross-Domain Identity Management (SCIM) protocol.

`display_name`^Required

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

Property displayName: The display name of the application.

The name can be up to 24 characters in length.

`access_token_validity`^Optional

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

Property accessTokenValidity: The validity period of the access token.

Valid values: 900 to 10800. Unit: seconds. Default value: 3600.

`is_multi_tenant`^Optional

Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property isMultiTenant: Indicates whether the application can be installed by using other Alibaba Cloud accounts.

Valid values:

true: If you do not set this parameter for applications of the NativeApp and ServerApp types, true is used.
false: If you do not set this parameter for applications of the WebApp type, false is used.

`predefined_scopes`^Optional

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

Property predefinedScopes: List of the scopes of application permissions.

`redirect_uris`^Optional

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

Property redirectUris: List of the callback URLs.

`refresh_token_validity`^Optional

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

Property refreshTokenValidity: The validity period of the refreshed token.

Valid values: 7200 to 31536000. Unit: seconds. Default value:

For applications of the WebApp and ServerApp types, if this parameter is left empty, the value 2592000 is used. The value 2592000 indicates that the validity period of the refreshed token is 30 days.
For applications of the NativeApp type, if this parameter is left empty, the value 7776000 is used. The value 7776000 indicates that the validity period of the refreshed token is 90 days.

`required_scopes`^Optional

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

Property requiredScopes: Required scope of application permissions.

You can set one or more of the scopes set in the PredefinedScopes to be required, so that when a user authorizes the application, the required scopes are selected by default and cannot be canceled. Notes: If you set a RequiredScopes entry that is not within the scope of PredefinedScopes, the required range will not take effect.

`secret_required`^Optional

Type: typing.Union[bool, ros_cdk_core.IResolvable]

Property secretRequired: Indicates whether a secret is required.

Valid values: true and false. Note:

For applications of the WebApp and ServerApp types, this parameter is automatically set to true and cannot be changed.
For applications of the NativeApp type, this parameter can be set to true or false. If you do not set this parameter, false is used. Applications of the NativeApp type run in untrusted environments and the secrets of these applications are not protected. Therefore, we recommend that you do not set this parameter to true unless otherwise specified.

`enable_resource_property_constraint`^Optional

Type: bool

Methods

Name	Description
`to_string`	Returns a string representation of this construct.
`synthesize`	Allows this construct to emit artifacts into the cloud assembly during synthesis.
`add_condition`	No description.
`add_count`	No description.
`add_dependency`	No description.
`add_resource_desc`	No description.
`apply_removal_policy`	No description.
`get_att`	No description.
`set_metadata`	No description.

`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

`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

Name	Description
`is_construct`	Return whether the given object is a Construct.

`is_construct`

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

Return whether the given object is a Construct.

x^Required

Type: typing.Any

Properties

Name	Type	Description
`node`	`ros_cdk_core.ConstructNode`	The construct tree node associated with this construct.
`ref`	`str`	No description.
`stack`	`ros_cdk_core.Stack`	The stack in which this resource is defined.
`resource`	`ros_cdk_core.RosResource`	No description.
`attr_app_id`	`ros_cdk_core.IResolvable`	Attribute AppId: The ID of the application.
`attr_app_name`	`ros_cdk_core.IResolvable`	Attribute AppName: The name of the application.

`node`^Required

node: ConstructNode

Type: ros_cdk_core.ConstructNode

The construct tree node associated with this construct.

`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_app_id`^Required

attr_app_id: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AppId: The ID of the application.

`attr_app_name`^Required

attr_app_name: IResolvable

Type: ros_cdk_core.IResolvable

Attribute AppName: The name of the application.

Application

Initializers

scopeRequired

idRequired

app_nameRequired

app_typeRequired

display_nameRequired

access_token_validityOptional

is_multi_tenantOptional

predefined_scopesOptional

redirect_urisOptional

refresh_token_validityOptional

required_scopesOptional

secret_requiredOptional

enable_resource_property_constraintOptional

Methods

to_string

synthesize

add_condition

add_count

add_dependency

add_resource_desc

apply_removal_policy

get_att

set_metadata