Skip to content

SitePair

This class encapsulates and extends the ROS resource type ALIYUN::HDR::SitePair.

Initializers

import com.aliyun.ros.cdk.hdr.SitePair;
SitePair.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .primarySiteName(java.lang.String)
    .primarySiteName(IResolvable)
    .primarySiteRegionId(java.lang.String)
    .primarySiteRegionId(IResolvable)
    .primarySiteType(java.lang.String)
    .primarySiteType(IResolvable)
    .primarySiteVpcId(java.lang.String)
    .primarySiteVpcId(IResolvable)
    .secondarySiteName(java.lang.String)
    .secondarySiteName(IResolvable)
    .secondarySiteRegionId(java.lang.String)
    .secondarySiteRegionId(IResolvable)
    .secondarySiteType(java.lang.String)
    .secondarySiteType(IResolvable)
    .secondarySiteVpcId(java.lang.String)
    .secondarySiteVpcId(IResolvable)
//  .primarySiteZoneId(java.lang.String)
//  .primarySiteZoneId(IResolvable)
//  .secondarySiteZoneId(java.lang.String)
//  .secondarySiteZoneId(IResolvable)
//  .sitePairType(java.lang.String)
//  .sitePairType(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.
primarySiteName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property primarySiteName: The name of the primary site.
primarySiteRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property primarySiteRegionId: The region ID of the primary site.
primarySiteType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property primarySiteType: The type of the primary site.
primarySiteVpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property primarySiteVpcId: The VPC ID of the primary site.
secondarySiteName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secondarySiteName: The name of the secondary site.
secondarySiteRegionId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secondarySiteRegionId: The region ID of the secondary site.
secondarySiteType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secondarySiteType: The type of the secondary site.
secondarySiteVpcId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secondarySiteVpcId: The VPC ID of the secondary site.
primarySiteZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property primarySiteZoneId: The zone ID of the primary site.
secondarySiteZoneId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property secondarySiteZoneId: The zone ID of the secondary site.
sitePairType java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property sitePairType: The type of the site pair.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

primarySiteNameRequired

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

Property primarySiteName: The name of the primary site.


primarySiteRegionIdRequired

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

Property primarySiteRegionId: The region ID of the primary site.


primarySiteTypeRequired

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

Property primarySiteType: The type of the primary site.


primarySiteVpcIdRequired

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

Property primarySiteVpcId: The VPC ID of the primary site.


secondarySiteNameRequired

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

Property secondarySiteName: The name of the secondary site.


secondarySiteRegionIdRequired

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

Property secondarySiteRegionId: The region ID of the secondary site.


secondarySiteTypeRequired

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

Property secondarySiteType: The type of the secondary site.


secondarySiteVpcIdRequired

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

Property secondarySiteVpcId: The VPC ID of the secondary site.


primarySiteZoneIdOptional

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

Property primarySiteZoneId: The zone ID of the primary site.

This parameter is valid only when the site pair type is cross-zone disaster recovery.


secondarySiteZoneIdOptional

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

Property secondarySiteZoneId: The zone ID of the secondary site.

This parameter is valid only when the site pair type is cross-zone disaster recovery.


sitePairTypeOptional

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

Property sitePairType: The type of the site pair.


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.hdr.SitePair;
SitePair.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.
attrPrimarySiteId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute PrimarySiteId: The ID of the primary site.
attrSecondarySiteId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SecondarySiteId: The ID of the secondary site.
attrSitePairId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SitePairId: The ID of the site pair.
props SitePairProps 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

attrPrimarySiteIdRequired

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

Attribute PrimarySiteId: The ID of the primary site.


attrSecondarySiteIdRequired

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

Attribute SecondarySiteId: The ID of the secondary site.


attrSitePairIdRequired

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

Attribute SitePairId: The ID of the site pair.


propsRequired

public SitePairProps getProps();

Structs