Connection
- Implements: IConnection
This class encapsulates and extends the ROS resource type ALIYUN::EventBridge::Connection.
Initializers
import com.aliyun.ros.cdk.eventbridge.Connection;
Connection.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.connectionName(java.lang.String)
.connectionName(IResolvable)
.networkParameters(IResolvable)
.networkParameters(NetworkParametersProperty)
// .authParameters(IResolvable)
// .authParameters(AuthParametersProperty)
// .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. |
connectionName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property connectionName: The connection configuration name. |
networkParameters | com.aliyun.ros.cdk.core.IResolvable OR NetworkParametersProperty | Property networkParameters: Network Configuration Data Structure. |
authParameters | com.aliyun.ros.cdk.core.IResolvable OR AuthParametersProperty | Property authParameters: Authentication Data Structure. |
description | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Property description: The connection configuration description. |
scopeRequired
- Type: com.aliyun.ros.cdk.core.Construct
idRequired
- Type: java.lang.String
enableResourcePropertyConstraintOptional
- Type: java.lang.Boolean
connectionNameRequired
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property connectionName: The connection configuration name.
The maximum length is 127 characters. Minimum length 2 characters.
networkParametersRequired
- Type: com.aliyun.ros.cdk.core.IResolvable OR NetworkParametersProperty
Property networkParameters: Network Configuration Data Structure.
authParametersOptional
- Type: com.aliyun.ros.cdk.core.IResolvable OR AuthParametersProperty
Property authParameters: Authentication Data Structure.
descriptionOptional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The connection configuration description.
The maximum length is 255 characters.
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.
- Type: com.aliyun.ros.cdk.core.ISynthesisSession
The synthesis session.
addCondition
public void addCondition(RosCondition condition)
- Type: com.aliyun.ros.cdk.core.RosCondition
addCount
public void addCount(java.lang.Number OR IResolvable count)
- Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable
addDependency
public void addDependency(Resource resource)
- Type: com.aliyun.ros.cdk.core.Resource
addResourceDesc
public void addResourceDesc(java.lang.String desc)
- Type: java.lang.String
applyRemovalPolicy
public void applyRemovalPolicy(RemovalPolicy policy)
- 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)
- Type: java.lang.String
setMetadata
public void setMetadata(java.lang.String key, java.lang.Object value)
- Type: java.lang.String
- Type: java.lang.Object
Static Functions
| Name | Description |
|---|---|
isConstruct | Return whether the given object is a Construct. |
isConstruct
import com.aliyun.ros.cdk.eventbridge.Connection;
Connection.isConstruct(java.lang.Object x)
Return whether the given object is a Construct.
- 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. |
attrAuthParameters | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute AuthParameters: Authentication Data Structure. |
attrConnectionName | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute ConnectionName: The connection configuration name. |
attrCreateTime | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute CreateTime: The creation time of the resource. |
attrDescription | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute Description: The connection configuration description. |
attrNetworkParameters | java.lang.String OR com.aliyun.ros.cdk.core.IResolvable | Attribute NetworkParameters: Network Configuration Data Structure. |
props | ConnectionProps | 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
attrAuthParametersRequired
public java.lang.Object getAttrAuthParameters();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute AuthParameters: Authentication Data Structure.
attrConnectionNameRequired
public java.lang.Object getAttrConnectionName();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute ConnectionName: The connection configuration name.
The maximum length is 127 characters. Minimum length 2 characters.
attrCreateTimeRequired
public java.lang.Object getAttrCreateTime();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute CreateTime: The creation time of the resource.
attrDescriptionRequired
public java.lang.Object getAttrDescription();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute Description: The connection configuration description.
The maximum length is 255 characters.
attrNetworkParametersRequired
public java.lang.Object getAttrNetworkParameters();
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Attribute NetworkParameters: Network Configuration Data Structure.
propsRequired
public ConnectionProps getProps();
- Type: ConnectionProps