Skip to content

AccessConfiguration

This class encapsulates and extends the ROS resource type ALIYUN::CloudSSO::AccessConfiguration, which is used to create an access configuration.

Initializers 

import com.aliyun.ros.cdk.cloudsso.AccessConfiguration;
AccessConfiguration.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .accessConfigurationName(java.lang.String)
    .accessConfigurationName(IResolvable)
    .directoryId(java.lang.String)
    .directoryId(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .relayState(java.lang.String)
//  .relayState(IResolvable)
//  .sessionDuration(java.lang.Number)
//  .sessionDuration(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.
accessConfigurationName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accessConfigurationName: The name of the access configuration.
directoryId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property directoryId: The ID of the directory.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the access configuration.
relayState java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property relayState: The initial web page that is displayed after a CloudSSO user accesses an account in your resource directory by using the access configuration.
sessionDuration java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property sessionDuration: The duration of a session in which a CloudSSO user accesses an account in your resource directory by using the access configuration.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

accessConfigurationNameRequired

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

Property accessConfigurationName: The name of the access configuration.

The name can contain letters, digits, and hyphens (-). The name can be up to 32 characters in length.

directoryIdRequired

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

Property directoryId: The ID of the directory.

descriptionOptional

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

Property description: The description of the access configuration.

The description can be up to 1,024 characters in length.

relayStateOptional

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

Property relayState: The initial web page that is displayed after a CloudSSO user accesses an account in your resource directory by using the access configuration.

The web page must be a page of the Alibaba Cloud Management Console. By default, this parameter is empty, which indicates that the initial web page is the homepage of the Alibaba Cloud Management Console.

sessionDurationOptional

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

Property sessionDuration: The duration of a session in which a CloudSSO user accesses an account in your resource directory by using the access configuration.

Unit: seconds. Valid values: 900 to 43200. The value 900 indicates 15 minutes. The value 43200 indicates 12 hours. Default value: 3600. The value indicates 1 hour.

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.
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

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.cloudsso.AccessConfiguration;
AccessConfiguration.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.
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.
attrAccessConfigurationId com.aliyun.ros.cdk.core.IResolvable Attribute AccessConfigurationId: The ID of the access configuration.

nodeRequired 

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

The construct tree node associated with this construct.

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

attrAccessConfigurationIdRequired 

public IResolvable getAttrAccessConfigurationId();
  • Type: com.aliyun.ros.cdk.core.IResolvable

Attribute AccessConfigurationId: The ID of the access configuration.