Skip to content

Authorization

This class encapsulates and extends the ROS resource type ALIYUN::ApiGateway::Authorization, which is used to authorize APIs to access applications.

Initializers 

import com.aliyun.ros.cdk.apigateway.Authorization;
Authorization.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .apiIds(java.util.List<java.lang.Object>)
    .apiIds(IResolvable)
    .appIds(java.util.List<java.lang.Object>)
    .appIds(IResolvable)
    .groupId(java.lang.String)
    .groupId(IResolvable)
    .stageName(java.lang.String)
    .stageName(IResolvable)
//  .authValidTime(java.lang.String)
//  .authValidTime(IResolvable)
//  .description(java.lang.String)
//  .description(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.
apiIds java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property apiIds: APIs to authorize.
appIds java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property appIds: APPs are authorized to APIs.
groupId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property groupId: The id of the group.
stageName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property stageName: Authorize in this stage.
authValidTime java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property authValidTime: The time (UTC) when the authorization expires.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: Description of the authorization, less than 180 characters.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

apiIdsRequired

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

Property apiIds: APIs to authorize.

appIdsRequired

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

Property appIds: APPs are authorized to APIs.

groupIdRequired

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

Property groupId: The id of the group.

stageNameRequired

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

Property stageName: Authorize in this stage.

authValidTimeOptional

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

Property authValidTime: The time (UTC) when the authorization expires.

If this parameter is empty, the authorization does not expire. Pattern: YYYY-MM-DDThh:mm:ssZ

descriptionOptional

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

Property description: Description of the authorization, less than 180 characters.

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.apigateway.Authorization;
Authorization.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.

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