Skip to content

FwSwitch

This class encapsulates and extends the ROS resource type ALIYUN::CLOUDFW::FwSwitch.

Initializers

import com.aliyun.ros.cdk.cloudfw.FwSwitch;
FwSwitch.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
//  .ipaddrList(java.util.List<java.lang.Object>)
//  .ipaddrList(IResolvable)
//  .ipVersion(java.lang.String)
//  .ipVersion(IResolvable)
//  .memberUid(java.lang.String)
//  .memberUid(IResolvable)
//  .regionList(java.util.List<java.lang.Object>)
//  .regionList(IResolvable)
//  .resourceTypeList(java.util.List<java.lang.Object>)
//  .resourceTypeList(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.
ipaddrList java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property ipaddrList: The IP address list.
ipVersion java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ipVersion: The IP version number.
memberUid java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property memberUid: The member unique identifier.
regionList java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property regionList: The region list.
resourceTypeList java.util.List OR com.aliyun.ros.cdk.core.IResolvable Property resourceTypeList: The list of asset types.

scopeRequired

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

idRequired

  • Type: java.lang.String

enableResourcePropertyConstraintOptional

  • Type: java.lang.Boolean

ipaddrListOptional

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

Property ipaddrList: The IP address list.

Note: The IpaddrList, RegionList, and ResourceTypeList arguments are not allowed to be empty at the same time. A value must be set for one of the three arguments.


ipVersionOptional

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

Property ipVersion: The IP version number.


memberUidOptional

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

Property memberUid: The member unique identifier.


regionListOptional

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

Property regionList: The region list.

Note: The IpaddrList, RegionList, and ResourceTypeList arguments are not allowed to be empty at the same time. A value must be set for one of the three arguments.


resourceTypeListOptional

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

Property resourceTypeList: The list of asset types.

Valid values:

  • BastionHostEgressIP: the egress IP address of a bastion host.
  • BastionHostIngressIP: the ingress IP address of a bastion host.
  • EcsEIP: the EIP of an ECS instance.
  • EcsPublicIP: the public IP address of an ECS instance.
  • EIP: an EIP.
  • EniEIP: the EIP of an ENI.
  • NatEIP: the EIP of a NAT gateway.
  • SlbEIP: the EIP of an SLB instance or a CLB instance.
  • SlbPublicIP: the public IP address of an SLB instance or a CLB instance.
  • NatPublicIP: the public IP address of a NAT gateway.
  • HAVIP: an HAVIP.
  • NlbEIP: the EIP of an NLB instance.
  • ApiGatewayEIP: the public IP address of an API gateway.
  • AlbEIP: the EIP of an ALB instance.
  • AiGatewayEIP: the public IP address of an AI gateway.
  • GaEIP: the EIP of a GA instance.
  • SwasEIP: the public IP address of a Simple Application Server instance.
  • EcdEIP: the public IP address of an Elastic Desktop Service instance.
  • BastionHostIP: the IP address of a bastion host.

You must specify at least one of the IpaddrList, RegionList, and ResourceTypeList parameters.


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.cloudfw.FwSwitch;
FwSwitch.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.
props FwSwitchProps 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

propsRequired

public FwSwitchProps getProps();