Package com.pulumi.aws.cloudwatch

Class EventApiDestination

  • public class EventApiDestination
extends com.pulumi.resources.CustomResource
    Provides an EventBridge event API Destination resource. > **Note:** EventBridge was formerly known as CloudWatch Events. The functionality is identical. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.cloudwatch.EventApiDestination;
 import com.pulumi.aws.cloudwatch.EventApiDestinationArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 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) {
         var test = new EventApiDestination("test", EventApiDestinationArgs.builder()
             .name("api-destination")
             .description("An API Destination")
             .invocationEndpoint("https://api.destination.com/endpoint")
             .httpMethod("POST")
             .invocationRateLimitPerSecond(20)
             .connectionArn(testAwsCloudwatchEventConnection.arn())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `name` (String) Name of the API destination. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import API Destinations using `name`. For example: ```sh $ pulumi import aws:cloudwatch/eventApiDestination:EventApiDestination example example-destination ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.lang.String> connectionArn()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static EventApiDestination get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, EventApiDestinationState state, com.pulumi.resources.CustomResourceOptions options)
      Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
      com.pulumi.core.Output<java.lang.String> httpMethod()  
      com.pulumi.core.Output<java.lang.String> invocationEndpoint()  
      com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> invocationRateLimitPerSecond()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

      • Methods inherited from class com.pulumi.resources.Resource

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • EventApiDestination

        public EventApiDestination​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • EventApiDestination

        public EventApiDestination​(java.lang.String name,
                           EventApiDestinationArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • EventApiDestination

        public EventApiDestination​(java.lang.String name,
                           EventApiDestinationArgs args,
                           @Nullable
                           com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the event API Destination.

      • connectionArn

        public com.pulumi.core.Output<java.lang.String> connectionArn()
        Returns:
        ARN of the EventBridge Connection to use for the API Destination.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        The description of the new API Destination. Maximum of 512 characters.

      • httpMethod

        public com.pulumi.core.Output<java.lang.String> httpMethod()
        Returns:
        Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.

      • invocationEndpoint

        public com.pulumi.core.Output<java.lang.String> invocationEndpoint()
        Returns:
        URL endpoint to invoke as a target. This could be a valid endpoint generated by a partner service. You can include "*" as path parameters wildcards to be set from the Target HttpParameters.

      • invocationRateLimitPerSecond

        public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> invocationRateLimitPerSecond()
        Returns:
        Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name of the new API Destination. The name must be unique for your account. Maximum of 64 characters consisting of numbers, lower/upper case letters, .,-,_.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • get

        public static EventApiDestination get​(java.lang.String name,
                                      com.pulumi.core.Output<java.lang.String> id,
                                      @Nullable
                                      EventApiDestinationState state,
                                      @Nullable
                                      com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.