Skip to content

OriginProtection

This class encapsulates and extends the ROS resource type ALIYUN::ESA::OriginProtection.

Initializers

import com.aliyun.ros.cdk.esa.OriginProtection;
OriginProtection.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .originConverge(java.lang.String)
//  .originConverge(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.
siteId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteId: Site Id.
originConverge java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property originConverge: The IP convergence status.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

siteIdRequired

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

Property siteId: Site Id.


originConvergeOptional

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

Property originConverge: The IP convergence status.

  • on
  • off.

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.esa.OriginProtection;
OriginProtection.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.
attrCurrentIpWhitelist java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute CurrentIpWhitelist: The IP whitelist for origin protection used by the website.
attrDiffIpWhitelist java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute DiffIpWhitelist: The IP whitelist for origin protection that has been updated.
attrLatestIpWhitelist java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute LatestIpWhitelist: The latest IP whitelist for origin protection.
attrOriginConverge java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute OriginConverge: The IP convergence status.
attrOriginProtection java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute OriginProtection: Indicates whether origin protection is enabled.
attrSiteId java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Attribute SiteId: The website ID.
props OriginProtectionProps 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

attrCurrentIpWhitelistRequired

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

Attribute CurrentIpWhitelist: The IP whitelist for origin protection used by the website.


attrDiffIpWhitelistRequired

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

Attribute DiffIpWhitelist: The IP whitelist for origin protection that has been updated.


attrLatestIpWhitelistRequired

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

Attribute LatestIpWhitelist: The latest IP whitelist for origin protection.


attrOriginConvergeRequired

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

Attribute OriginConverge: The IP convergence status.


attrOriginProtectionRequired

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

Attribute OriginProtection: Indicates whether origin protection is enabled.


attrSiteIdRequired

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

Attribute SiteId: The website ID.


propsRequired

public OriginProtectionProps getProps();