Skip to content

CenRouteService

This class encapsulates and extends the ROS resource type ALIYUN::CEN::CenRouteService.

Initializers

import com.aliyun.ros.cdk.cen.CenRouteService;
CenRouteService.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .accessRegionId(java.lang.String)
    .accessRegionId(IResolvable)
    .cenId(java.lang.String)
    .cenId(IResolvable)
    .host(java.lang.String)
    .host(IResolvable)
    .hostRegionId(java.lang.String)
    .hostRegionId(IResolvable)
    .hostVpcId(java.lang.String)
    .hostVpcId(IResolvable)
//  .conflictIgnore(java.lang.Boolean)
//  .conflictIgnore(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.
accessRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property accessRegionId: The region where the cloud service is deployed.
cenId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property cenId: The ID of the Cloud Enterprise Network (CEN) instance.
host java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property host: The IP addresses or CIDR blocks of the cloud service.
hostRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hostRegionId: The region where the cloud service is deployed.
hostVpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property hostVpcId: The virtual private cloud (VPC) that is associated with the cloud service.
conflictIgnore java.lang.Boolean OR com.aliyun.ros.cdk.core.IResolvable Property conflictIgnore: Whether to ignore conflict when creating.
description java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property description: The description of the cloud service.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

accessRegionIdRequired

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

Property accessRegionId: The region where the cloud service is deployed.


cenIdRequired

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

Property cenId: The ID of the Cloud Enterprise Network (CEN) instance.


hostRequired

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

Property host: The IP addresses or CIDR blocks of the cloud service.

In most cases, multiple IP addresses or CIDR blocks are assigned to a cloud service. We recommend that you call this operation multiple times to add all IP addresses and CIDR blocks of the cloud service.


hostRegionIdRequired

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

Property hostRegionId: The region where the cloud service is deployed.

You can call the DescribeRegions operation to query region IDs. Note The HostRegionId and AccessRegionIds.N must be set to the same value.


hostVpcIdRequired

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

Property hostVpcId: The virtual private cloud (VPC) that is associated with the cloud service.


conflictIgnoreOptional

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

Property conflictIgnore: Whether to ignore conflict when creating.

If true, when the CloudRoute.Conflict error code is encountered during creation, it will be ignored as the creation is successful, and the deletion phase will be skipped. Default false.


descriptionOptional

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

Property description: The description of the cloud service.

This parameter is optional. If you enter a description, it must be 1 to 256 characters in length and cannot start with http:// or https://.


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.
fetchCondition No description.
fetchDependency No description.
fetchResourceDesc 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

fetchCondition

public RosCondition fetchCondition()

fetchDependency

public java.util.List<java.lang.String> fetchDependency()

fetchResourceDesc

public java.lang.String fetchResourceDesc()

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.cen.CenRouteService;
CenRouteService.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.
env com.aliyun.ros.cdk.core.IResourceEnvironment The environment this resource belongs to.
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.
attrId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute Id: The ID of the cloud service.
props CenRouteServiceProps No description.

nodeRequired

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

The construct tree node associated with this construct.


envRequired

public IResourceEnvironment getEnv();
  • Type: com.aliyun.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.


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

attrIdRequired

public java.lang.Object getAttrId();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Attribute Id: The ID of the cloud service.

It is formatted to {CenId}/{HostRegionId}/{Host}/{AccessRegionId}


propsRequired

public CenRouteServiceProps getProps();