Policy

This class encapsulates and extends the ROS resource type ALIYUN::APIG::Policy.

Initializers

import com.aliyun.ros.cdk.apig.Policy;
Policy.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .attachResourceIds(IResolvable)
    .attachResourceIds(java.util.List<java.lang.String)
    .attachResourceIds(IResolvable>)
    .attachResourceType(java.lang.String)
    .attachResourceType(IResolvable)
    .environmentId(java.lang.String)
    .environmentId(IResolvable)
    .gatewayId(java.lang.String)
    .gatewayId(IResolvable)
    .policyClassName(java.lang.String)
    .policyClassName(IResolvable)
    .policyConfig(java.lang.String)
    .policyConfig(IResolvable)
//  .policyName(java.lang.String)
//  .policyName(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.
`attachResourceIds`	`com.aliyun.ros.cdk.core.IResolvable OR java.util.List`	Property attachResourceIds: The Mount point id list.
`attachResourceType`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property attachResourceType: Policies support mount point types.
`environmentId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property environmentId: The id of the environment.
`gatewayId`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property gatewayId: The ID of the Gateway.
`policyClassName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property policyClassName: The name of the policy class.
`policyConfig`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property policyConfig: Policy Configuration.
`policyName`	`java.lang.String OR com.aliyun.ros.cdk.core.IResolvable`	Property policyName: The name of the policy.

`scope`^Required

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

`id`^Required

Type: java.lang.String

`enableResourcePropertyConstraint`^Optional

Type: java.lang.Boolean

`attachResourceIds`^Required

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

Property attachResourceIds: The Mount point id list.

`attachResourceType`^Required

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

Property attachResourceType: Policies support mount point types.

HttpApi:HttpApi. Operation: the Operation of the HttpApi. GatewayRoute: Gateway route. GatewayService: Gateway service. GatewayServicePort: The Gateway service port. Domain: The Gateway Domain name. Gateway: Gateway.

`environmentId`^Required

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

Property environmentId: The id of the environment.

`gatewayId`^Required

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

Property gatewayId: The ID of the Gateway.

`policyClassName`^Required

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

Property policyClassName: The name of the policy class.

`policyConfig`^Required

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

Property policyConfig: Policy Configuration.

`policyName`^Optional

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

Property policyName: The name of the policy.

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.

session^Required

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

The synthesis session.

`addCondition`

public void addCondition(RosCondition condition)

condition^Required

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

`addCount`

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

count^Required

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

`addDependency`

public void addDependency(Resource resource)

resource^Required

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

`addResourceDesc`

public void addResourceDesc(java.lang.String desc)

desc^Required

Type: java.lang.String

`applyRemovalPolicy`

public void applyRemovalPolicy(RemovalPolicy policy)

policy^Required

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

`getAtt`

public IResolvable getAtt(java.lang.String name)

name^Required

Type: java.lang.String

`setMetadata`

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

key^Required

Type: java.lang.String

value^Required

Type: java.lang.Object

Static Functions

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

`isConstruct`

import com.aliyun.ros.cdk.apig.Policy;
Policy.isConstruct(java.lang.Object x)

Return whether the given object is a Construct.

x^Required

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.
`attrPolicyClassId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute PolicyClassId: The ID of policy class.
`attrPolicyClassName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute PolicyClassName: The name of policy class.
`attrPolicyConfig`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute PolicyConfig: Policy Configuration.
`attrPolicyId`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute PolicyId: The ID of the policy.
`attrPolicyName`	`com.aliyun.ros.cdk.core.IResolvable`	Attribute PolicyName: The name of the policy.

`node`^Required

public ConstructNode getNode();

Type: com.aliyun.ros.cdk.core.ConstructNode

The construct tree node associated with this construct.

`ref`^Required

public java.lang.String getRef();

Type: java.lang.String

`stack`^Required

public Stack getStack();

Type: com.aliyun.ros.cdk.core.Stack

The stack in which this resource is defined.

`resource`^Optional

public RosResource getResource();

Type: com.aliyun.ros.cdk.core.RosResource

`attrPolicyClassId`^Required

public IResolvable getAttrPolicyClassId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PolicyClassId: The ID of policy class.

`attrPolicyClassName`^Required

public IResolvable getAttrPolicyClassName();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PolicyClassName: The name of policy class.

`attrPolicyConfig`^Required

public IResolvable getAttrPolicyConfig();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PolicyConfig: Policy Configuration.

`attrPolicyId`^Required

public IResolvable getAttrPolicyId();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PolicyId: The ID of the policy.

`attrPolicyName`^Required

public IResolvable getAttrPolicyName();

Type: com.aliyun.ros.cdk.core.IResolvable

Attribute PolicyName: The name of the policy.

Policy

Initializers

scopeRequired

idRequired

enableResourcePropertyConstraintOptional

attachResourceIdsRequired

attachResourceTypeRequired

environmentIdRequired

gatewayIdRequired

policyClassNameRequired

policyConfigRequired

policyNameOptional

Methods

toString

synthesize

addCondition

addCount

addDependency

addResourceDesc

applyRemovalPolicy

getAtt

setMetadata