DeliveryChannel
This class encapsulates and extends the ROS resource type ALIYUN::Config::DeliveryChannel
, which is used to create or update a delivery channel.
Initializers
import com.aliyun.ros.cdk.config.DeliveryChannel;
DeliveryChannel.Builder.create(Construct scope, java.lang.String id, java.lang.Boolean enableResourcePropertyConstraint)
.deliveryChannelAssumeRoleArn(java.lang.String)
.deliveryChannelAssumeRoleArn(IResolvable)
.deliveryChannelTargetArn(java.lang.String)
.deliveryChannelTargetArn(IResolvable)
.deliveryChannelType(java.lang.String)
.deliveryChannelType(IResolvable)
// .deliveryChannelCondition(java.lang.String)
// .deliveryChannelCondition(IResolvable)
// .deliveryChannelName(java.lang.String)
// .deliveryChannelName(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. |
deliveryChannelAssumeRoleArn |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property deliveryChannelAssumeRoleArn: The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method. |
deliveryChannelTargetArn |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property deliveryChannelTargetArn: The ARN of the delivery destination. |
deliveryChannelType |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property deliveryChannelType: The type of the delivery method. |
deliveryChannelCondition |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property deliveryChannelCondition: The rule attached to the delivery method. |
deliveryChannelName |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property deliveryChannelName: The name of the delivery method. |
description |
java.lang.String OR com.aliyun.ros.cdk.core.IResolvable |
Property description: The description of the delivery method. |
scope
Required
- Type: com.aliyun.ros.cdk.core.Construct
id
Required
- Type: java.lang.String
enableResourcePropertyConstraint
Optional
- Type: java.lang.Boolean
deliveryChannelAssumeRoleArn
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property deliveryChannelAssumeRoleArn: The Alibaba Cloud Resource Name (ARN) of the role to be assumed by the delivery method.
This parameter is required when you create a delivery method. Note If the delivery method assumes the service linked role for Cloud Config, you can specify the ARN in the format of the provided example and replace the account ID with the ID of your Alibaba Cloud account.
deliveryChannelTargetArn
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property deliveryChannelTargetArn: The ARN of the delivery destination.
This parameter is required when you create a delivery method. The value must be in one of the following formats: acs:oss:{RegionId}:{Aliuid}:{bucketName} if your delivery destination is an Object Storage Service (OSS) bucket. acs:mns:{RegionId}:{Aliuid}:/topics/{topicName} if your delivery destination is a Message Service (MNS) topic. acs:log:{RegionId}:{Aliuid}:project/{projectName}/logstore/{logstoreName} if your delivery destination is a Log Service Logstore.
deliveryChannelType
Required
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property deliveryChannelType: The type of the delivery method.
This parameter is required when you create a delivery method. Valid values: OSS MNS SLS
deliveryChannelCondition
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property deliveryChannelCondition: The rule attached to the delivery method.
This parameter is applicable only to delivery methods of the MNS type. This parameter allows you to specify the lowest risk level for the events to subscribe to and the resource types for which you want to subscribe to events. To specify the lowest risk level for the events to subscribe to, use the following format:{"filterType":"RuleRiskLevel","value":"1","multiple":false}. The value field indicates the lowest risk level and can be set to 1, 2, or 3, which indicates the high risk level, the medium risk level, and the low risk level, respectively. To specify the resource types for which you want to subscribe to events, use the following format:{"filterType":"ResourceType","values":["ACS::ACK::Cluster","ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage"],"multiple":true}. The values field indicates the resource types. Its value is a JSON array. Example: [{"filterType":"ResourceType","values":["ACS::ActionTrail::Trail","ACS::CBWP::CommonBandwidthPackage","ACS::CDN::Domain","ACS::CEN::CenBandwidthPackage","ACS::CEN::CenInstance","ACS::CEN::Flowlog","ACS::DdosCoo::Instance"],"multiple":true}]
deliveryChannelName
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property deliveryChannelName: The name of the delivery method.
description
Optional
- Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable
Property description: The description of the delivery method.
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. |
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
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.config.DeliveryChannel;
DeliveryChannel.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. |
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. |
attrDeliveryChannelId |
com.aliyun.ros.cdk.core.IResolvable |
Attribute DeliveryChannelId: The ID of the delivery method. |
node
Required
public ConstructNode getNode();
- Type: com.aliyun.ros.cdk.core.ConstructNode
The construct tree node associated with this construct.
ref
Required
public java.lang.String getRef();
- Type: java.lang.String
stack
Required
public Stack getStack();
- Type: com.aliyun.ros.cdk.core.Stack
The stack in which this resource is defined.
resource
Optional
public RosResource getResource();
- Type: com.aliyun.ros.cdk.core.RosResource
attrDeliveryChannelId
Required
public IResolvable getAttrDeliveryChannelId();
- Type: com.aliyun.ros.cdk.core.IResolvable
Attribute DeliveryChannelId: The ID of the delivery method.