1. Packages
  2. Alibaba Cloud
  3. API Docs
  4. eventbridge
  5. ApiDestination
Alibaba Cloud v3.52.1 published on Thursday, Apr 4, 2024 by Pulumi

alicloud.eventbridge.ApiDestination

Explore with Pulumi AI

alicloud logo
Alibaba Cloud v3.52.1 published on Thursday, Apr 4, 2024 by Pulumi

    Provides a Event Bridge Api Destination resource.

    For information about Event Bridge Api Destination and how to use it, see What is Api Destination.

    NOTE: Available since v1.211.0.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as alicloud from "@pulumi/alicloud";
    
    const config = new pulumi.Config();
    const region = config.get("region") || "cn-chengdu";
    const name = config.get("name") || "terraform-example";
    const defaultConnection = new alicloud.eventbridge.Connection("defaultConnection", {
        connectionName: name,
        networkParameters: {
            networkType: "PublicNetwork",
        },
    });
    const defaultApiDestination = new alicloud.eventbridge.ApiDestination("defaultApiDestination", {
        connectionName: defaultConnection.connectionName,
        apiDestinationName: name,
        description: "test-api-destination-connection",
        httpApiParameters: {
            endpoint: "http://127.0.0.1:8001",
            method: "POST",
        },
    });
    
    import pulumi
    import pulumi_alicloud as alicloud
    
    config = pulumi.Config()
    region = config.get("region")
    if region is None:
        region = "cn-chengdu"
    name = config.get("name")
    if name is None:
        name = "terraform-example"
    default_connection = alicloud.eventbridge.Connection("defaultConnection",
        connection_name=name,
        network_parameters=alicloud.eventbridge.ConnectionNetworkParametersArgs(
            network_type="PublicNetwork",
        ))
    default_api_destination = alicloud.eventbridge.ApiDestination("defaultApiDestination",
        connection_name=default_connection.connection_name,
        api_destination_name=name,
        description="test-api-destination-connection",
        http_api_parameters=alicloud.eventbridge.ApiDestinationHttpApiParametersArgs(
            endpoint="http://127.0.0.1:8001",
            method="POST",
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-alicloud/sdk/v3/go/alicloud/eventbridge"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		region := "cn-chengdu"
    		if param := cfg.Get("region"); param != "" {
    			region = param
    		}
    		name := "terraform-example"
    		if param := cfg.Get("name"); param != "" {
    			name = param
    		}
    		defaultConnection, err := eventbridge.NewConnection(ctx, "defaultConnection", &eventbridge.ConnectionArgs{
    			ConnectionName: pulumi.String(name),
    			NetworkParameters: &eventbridge.ConnectionNetworkParametersArgs{
    				NetworkType: pulumi.String("PublicNetwork"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		_, err = eventbridge.NewApiDestination(ctx, "defaultApiDestination", &eventbridge.ApiDestinationArgs{
    			ConnectionName:     defaultConnection.ConnectionName,
    			ApiDestinationName: pulumi.String(name),
    			Description:        pulumi.String("test-api-destination-connection"),
    			HttpApiParameters: &eventbridge.ApiDestinationHttpApiParametersArgs{
    				Endpoint: pulumi.String("http://127.0.0.1:8001"),
    				Method:   pulumi.String("POST"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using AliCloud = Pulumi.AliCloud;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var region = config.Get("region") ?? "cn-chengdu";
        var name = config.Get("name") ?? "terraform-example";
        var defaultConnection = new AliCloud.EventBridge.Connection("defaultConnection", new()
        {
            ConnectionName = name,
            NetworkParameters = new AliCloud.EventBridge.Inputs.ConnectionNetworkParametersArgs
            {
                NetworkType = "PublicNetwork",
            },
        });
    
        var defaultApiDestination = new AliCloud.EventBridge.ApiDestination("defaultApiDestination", new()
        {
            ConnectionName = defaultConnection.ConnectionName,
            ApiDestinationName = name,
            Description = "test-api-destination-connection",
            HttpApiParameters = new AliCloud.EventBridge.Inputs.ApiDestinationHttpApiParametersArgs
            {
                Endpoint = "http://127.0.0.1:8001",
                Method = "POST",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.alicloud.eventbridge.Connection;
    import com.pulumi.alicloud.eventbridge.ConnectionArgs;
    import com.pulumi.alicloud.eventbridge.inputs.ConnectionNetworkParametersArgs;
    import com.pulumi.alicloud.eventbridge.ApiDestination;
    import com.pulumi.alicloud.eventbridge.ApiDestinationArgs;
    import com.pulumi.alicloud.eventbridge.inputs.ApiDestinationHttpApiParametersArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var config = ctx.config();
            final var region = config.get("region").orElse("cn-chengdu");
            final var name = config.get("name").orElse("terraform-example");
            var defaultConnection = new Connection("defaultConnection", ConnectionArgs.builder()        
                .connectionName(name)
                .networkParameters(ConnectionNetworkParametersArgs.builder()
                    .networkType("PublicNetwork")
                    .build())
                .build());
    
            var defaultApiDestination = new ApiDestination("defaultApiDestination", ApiDestinationArgs.builder()        
                .connectionName(defaultConnection.connectionName())
                .apiDestinationName(name)
                .description("test-api-destination-connection")
                .httpApiParameters(ApiDestinationHttpApiParametersArgs.builder()
                    .endpoint("http://127.0.0.1:8001")
                    .method("POST")
                    .build())
                .build());
    
        }
    }
    
    configuration:
      region:
        type: string
        default: cn-chengdu
      name:
        type: string
        default: terraform-example
    resources:
      defaultConnection:
        type: alicloud:eventbridge:Connection
        properties:
          connectionName: ${name}
          networkParameters:
            networkType: PublicNetwork
      defaultApiDestination:
        type: alicloud:eventbridge:ApiDestination
        properties:
          connectionName: ${defaultConnection.connectionName}
          apiDestinationName: ${name}
          description: test-api-destination-connection
          httpApiParameters:
            endpoint: http://127.0.0.1:8001
            method: POST
    

    Create ApiDestination Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ApiDestination(name: string, args: ApiDestinationArgs, opts?: CustomResourceOptions);
    @overload
    def ApiDestination(resource_name: str,
                       args: ApiDestinationArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def ApiDestination(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       api_destination_name: Optional[str] = None,
                       connection_name: Optional[str] = None,
                       http_api_parameters: Optional[ApiDestinationHttpApiParametersArgs] = None,
                       description: Optional[str] = None)
    func NewApiDestination(ctx *Context, name string, args ApiDestinationArgs, opts ...ResourceOption) (*ApiDestination, error)
    public ApiDestination(string name, ApiDestinationArgs args, CustomResourceOptions? opts = null)
    public ApiDestination(String name, ApiDestinationArgs args)
    public ApiDestination(String name, ApiDestinationArgs args, CustomResourceOptions options)
    
    type: alicloud:eventbridge:ApiDestination
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ApiDestinationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ApiDestinationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ApiDestinationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ApiDestinationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ApiDestinationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var apiDestinationResource = new AliCloud.EventBridge.ApiDestination("apiDestinationResource", new()
    {
        ApiDestinationName = "string",
        ConnectionName = "string",
        HttpApiParameters = new AliCloud.EventBridge.Inputs.ApiDestinationHttpApiParametersArgs
        {
            Endpoint = "string",
            Method = "string",
        },
        Description = "string",
    });
    
    example, err := eventbridge.NewApiDestination(ctx, "apiDestinationResource", &eventbridge.ApiDestinationArgs{
    	ApiDestinationName: pulumi.String("string"),
    	ConnectionName:     pulumi.String("string"),
    	HttpApiParameters: &eventbridge.ApiDestinationHttpApiParametersArgs{
    		Endpoint: pulumi.String("string"),
    		Method:   pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    })
    
    var apiDestinationResource = new ApiDestination("apiDestinationResource", ApiDestinationArgs.builder()        
        .apiDestinationName("string")
        .connectionName("string")
        .httpApiParameters(ApiDestinationHttpApiParametersArgs.builder()
            .endpoint("string")
            .method("string")
            .build())
        .description("string")
        .build());
    
    api_destination_resource = alicloud.eventbridge.ApiDestination("apiDestinationResource",
        api_destination_name="string",
        connection_name="string",
        http_api_parameters=alicloud.eventbridge.ApiDestinationHttpApiParametersArgs(
            endpoint="string",
            method="string",
        ),
        description="string")
    
    const apiDestinationResource = new alicloud.eventbridge.ApiDestination("apiDestinationResource", {
        apiDestinationName: "string",
        connectionName: "string",
        httpApiParameters: {
            endpoint: "string",
            method: "string",
        },
        description: "string",
    });
    
    type: alicloud:eventbridge:ApiDestination
    properties:
        apiDestinationName: string
        connectionName: string
        description: string
        httpApiParameters:
            endpoint: string
            method: string
    

    ApiDestination Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The ApiDestination resource accepts the following input properties:

    ApiDestinationName string
    The name of the API destination.
    ConnectionName string
    The name of the connection.
    HttpApiParameters Pulumi.AliCloud.EventBridge.Inputs.ApiDestinationHttpApiParameters
    The parameters that are configured for the API destination. See http_api_parameters below.
    Description string
    The description of the API destination.
    ApiDestinationName string
    The name of the API destination.
    ConnectionName string
    The name of the connection.
    HttpApiParameters ApiDestinationHttpApiParametersArgs
    The parameters that are configured for the API destination. See http_api_parameters below.
    Description string
    The description of the API destination.
    apiDestinationName String
    The name of the API destination.
    connectionName String
    The name of the connection.
    httpApiParameters ApiDestinationHttpApiParameters
    The parameters that are configured for the API destination. See http_api_parameters below.
    description String
    The description of the API destination.
    apiDestinationName string
    The name of the API destination.
    connectionName string
    The name of the connection.
    httpApiParameters ApiDestinationHttpApiParameters
    The parameters that are configured for the API destination. See http_api_parameters below.
    description string
    The description of the API destination.
    api_destination_name str
    The name of the API destination.
    connection_name str
    The name of the connection.
    http_api_parameters ApiDestinationHttpApiParametersArgs
    The parameters that are configured for the API destination. See http_api_parameters below.
    description str
    The description of the API destination.
    apiDestinationName String
    The name of the API destination.
    connectionName String
    The name of the connection.
    httpApiParameters Property Map
    The parameters that are configured for the API destination. See http_api_parameters below.
    description String
    The description of the API destination.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the ApiDestination resource produces the following output properties:

    CreateTime int
    The creation time of the Api Destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreateTime int
    The creation time of the Api Destination.
    Id string
    The provider-assigned unique ID for this managed resource.
    createTime Integer
    The creation time of the Api Destination.
    id String
    The provider-assigned unique ID for this managed resource.
    createTime number
    The creation time of the Api Destination.
    id string
    The provider-assigned unique ID for this managed resource.
    create_time int
    The creation time of the Api Destination.
    id str
    The provider-assigned unique ID for this managed resource.
    createTime Number
    The creation time of the Api Destination.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing ApiDestination Resource

    Get an existing ApiDestination resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: ApiDestinationState, opts?: CustomResourceOptions): ApiDestination
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_destination_name: Optional[str] = None,
            connection_name: Optional[str] = None,
            create_time: Optional[int] = None,
            description: Optional[str] = None,
            http_api_parameters: Optional[ApiDestinationHttpApiParametersArgs] = None) -> ApiDestination
    func GetApiDestination(ctx *Context, name string, id IDInput, state *ApiDestinationState, opts ...ResourceOption) (*ApiDestination, error)
    public static ApiDestination Get(string name, Input<string> id, ApiDestinationState? state, CustomResourceOptions? opts = null)
    public static ApiDestination get(String name, Output<String> id, ApiDestinationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiDestinationName string
    The name of the API destination.
    ConnectionName string
    The name of the connection.
    CreateTime int
    The creation time of the Api Destination.
    Description string
    The description of the API destination.
    HttpApiParameters Pulumi.AliCloud.EventBridge.Inputs.ApiDestinationHttpApiParameters
    The parameters that are configured for the API destination. See http_api_parameters below.
    ApiDestinationName string
    The name of the API destination.
    ConnectionName string
    The name of the connection.
    CreateTime int
    The creation time of the Api Destination.
    Description string
    The description of the API destination.
    HttpApiParameters ApiDestinationHttpApiParametersArgs
    The parameters that are configured for the API destination. See http_api_parameters below.
    apiDestinationName String
    The name of the API destination.
    connectionName String
    The name of the connection.
    createTime Integer
    The creation time of the Api Destination.
    description String
    The description of the API destination.
    httpApiParameters ApiDestinationHttpApiParameters
    The parameters that are configured for the API destination. See http_api_parameters below.
    apiDestinationName string
    The name of the API destination.
    connectionName string
    The name of the connection.
    createTime number
    The creation time of the Api Destination.
    description string
    The description of the API destination.
    httpApiParameters ApiDestinationHttpApiParameters
    The parameters that are configured for the API destination. See http_api_parameters below.
    api_destination_name str
    The name of the API destination.
    connection_name str
    The name of the connection.
    create_time int
    The creation time of the Api Destination.
    description str
    The description of the API destination.
    http_api_parameters ApiDestinationHttpApiParametersArgs
    The parameters that are configured for the API destination. See http_api_parameters below.
    apiDestinationName String
    The name of the API destination.
    connectionName String
    The name of the connection.
    createTime Number
    The creation time of the Api Destination.
    description String
    The description of the API destination.
    httpApiParameters Property Map
    The parameters that are configured for the API destination. See http_api_parameters below.

    Supporting Types

    ApiDestinationHttpApiParameters, ApiDestinationHttpApiParametersArgs

    Endpoint string
    The endpoint of the API destination.
    Method string
    The HTTP request method. Valid values: GET, POST, HEAD, DELETE, PUT, PATCH.
    Endpoint string
    The endpoint of the API destination.
    Method string
    The HTTP request method. Valid values: GET, POST, HEAD, DELETE, PUT, PATCH.
    endpoint String
    The endpoint of the API destination.
    method String
    The HTTP request method. Valid values: GET, POST, HEAD, DELETE, PUT, PATCH.
    endpoint string
    The endpoint of the API destination.
    method string
    The HTTP request method. Valid values: GET, POST, HEAD, DELETE, PUT, PATCH.
    endpoint str
    The endpoint of the API destination.
    method str
    The HTTP request method. Valid values: GET, POST, HEAD, DELETE, PUT, PATCH.
    endpoint String
    The endpoint of the API destination.
    method String
    The HTTP request method. Valid values: GET, POST, HEAD, DELETE, PUT, PATCH.

    Import

    Event Bridge Api Destination can be imported using the id, e.g.

    $ pulumi import alicloud:eventbridge/apiDestination:ApiDestination example <id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Alibaba Cloud pulumi/pulumi-alicloud
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the alicloud Terraform Provider.
    alicloud logo
    Alibaba Cloud v3.52.1 published on Thursday, Apr 4, 2024 by Pulumi