Use the ALIYUN::EventBridge::ApiDestination type to create an API destination.
Syntax
{
"Type": "ALIYUN::EventBridge::ApiDestination",
"Properties": {
"ApiDestinationName": String,
"ConnectionName": String,
"HttpApiParameters": Map,
"Description": String
}
}Properties
Parameter | Type | Required | Update allowed | Description | Constraints |
ApiDestinationName | String | Yes | No | The name of the API destination. | The name must be 2 to 127 characters long. |
ConnectionName | String | Yes | Yes | The name of the connection configuration. | The name must be 2 to 127 characters long. |
HttpApiParameters | Map | Yes | Yes | The configuration parameters for the API destination. | For more information, see HttpApiParameters properties. |
Description | String | No | Yes | The description of the API destination. | The description can be up to 255 characters long. |
HttpApiParameters syntax
"HttpApiParameters": {
"Endpoint": String,
"Method": String
}HttpApiParameters properties
Parameter | Type | Required | Update allowed | Description | Constraints |
Endpoint | String | Yes | Yes | The endpoint for the API destination. | The endpoint can be up to 127 characters long. |
Method | String | Yes | Yes | The HTTP request method. | Valid values:
|
Return values
Fn::GetAtt
ConnectionName: The name of the connection configuration.Description: The description of the API destination.CreateTime: The time when the API destination was created.HttpApiParameters: The configuration parameters for the API destination.ApiDestinationName: The name of the API destination.
Examples
ROSTemplateFormatVersion: '2015-09-01'
Parameters:
ApiDestinationName:
Description:
en: The name of the API destination. It must be 2 to 127 characters long.
Required: true
Type: String
ConnectionName:
Description:
en: 'The name of the connection configuration. It must be 2 to 127 characters long.
Note: You must first create a connection configuration and provide its name.'
Required: true
Type: String
Description:
AssociationProperty: TextArea
Description:
en: The description of the API destination. It can be up to 255 characters long.
Required: false
Type: String
HttpApiParameters:
AssociationPropertyMetadata:
Parameters:
Endpoint:
Description:
en: The endpoint for the API destination. It can be up to 127 characters
long.
Required: true
Type: String
Method:
AllowedValues:
- GET
- POST
- HEAD
- DELETE
- PUT
- PATCH
Description:
en: 'The HTTP request method.'
Required: true
Type: String
Description:
en: The configuration parameters for the API destination.
Required: true
Type: Json
Resources:
ExtensionResource:
Properties:
ApiDestinationName:
Ref: ApiDestinationName
ConnectionName:
Ref: ConnectionName
Description:
Ref: Description
HttpApiParameters:
Ref: HttpApiParameters
Type: ALIYUN::EventBridge::ApiDestination
Outputs:
ApiDestinationName:
Description: The name of the API destination.
Value:
Fn::GetAtt:
- ExtensionResource
- ApiDestinationName
ConnectionName:
Description: The name of the connection configuration.
Value:
Fn::GetAtt:
- ExtensionResource
- ConnectionName
CreateTime:
Description: The time when the API destination was created.
Value:
Fn::GetAtt:
- ExtensionResource
- CreateTime
Description:
Description: The description of the API destination.
Value:
Fn::GetAtt:
- ExtensionResource
- Description
HttpApiParameters:
Description: The configuration parameters for the API destination.
Value:
Fn::GetAtt:
- ExtensionResource
- HttpApiParameters
{
"ROSTemplateFormatVersion": "2015-09-01",
"Parameters": {
"ConnectionName": {
"Type": "String",
"Description": {
"en": "The name of the connection configuration. It must be 2 to 127 characters long. Note: You must first create a connection configuration and provide its name."
},
"Required": true
},
"Description": {
"Type": "String",
"AssociationProperty": "TextArea",
"Description": {
"en": "The description of the API destination. It can be up to 255 characters long."
},
"Required": false
},
"HttpApiParameters": {
"AssociationPropertyMetadata": {
"Parameters": {
"Endpoint": {
"Type": "String",
"Description": {
"en": "The endpoint for the API destination. It can be up to 127 characters long."
},
"Required": true
},
"Method": {
"Type": "String",
"Description": {
"en": "The HTTP request method."
},
"AllowedValues": [
"GET",
"POST",
"HEAD",
"DELETE",
"PUT",
"PATCH"
],
"Required": true
}
}
},
"Type": "Json",
"Description": {
"en": "The configuration parameters for the API destination."
},
"Required": true
},
"ApiDestinationName": {
"Type": "String",
"Description": {
"en": "The name of the API destination. It must be 2 to 127 characters long."
},
"Required": true
}
},
"Resources": {
"ExtensionResource": {
"Type": "ALIYUN::EventBridge::ApiDestination",
"Properties": {
"ConnectionName": {
"Ref": "ConnectionName"
},
"Description": {
"Ref": "Description"
},
"HttpApiParameters": {
"Ref": "HttpApiParameters"
},
"ApiDestinationName": {
"Ref": "ApiDestinationName"
}
}
}
},
"Outputs": {
"ConnectionName": {
"Description": "The name of the connection configuration.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"ConnectionName"
]
}
},
"Description": {
"Description": "The description of the API destination.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"Description"
]
}
},
"CreateTime": {
"Description": "The time when the API destination was created.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"CreateTime"
]
}
},
"HttpApiParameters": {
"Description": "The configuration parameters for the API destination.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"HttpApiParameters"
]
}
},
"ApiDestinationName": {
"Description": "The name of the API destination.",
"Value": {
"Fn::GetAtt": [
"ExtensionResource",
"ApiDestinationName"
]
}
}
}
}