com.pulumi.aws.cloudwatch.EventApiDestination Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.cloudwatch;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.cloudwatch.EventApiDestinationArgs;
import com.pulumi.aws.cloudwatch.inputs.EventApiDestinationState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Integer;
import java.lang.String;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides an EventBridge event API Destination resource.
*
* > **Note:** EventBridge was formerly known as CloudWatch Events. The functionality is identical.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* 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.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) {
* 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());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import EventBridge API Destinations using the `name`. For example:
*
* ```sh
* $ pulumi import aws:cloudwatch/eventApiDestination:EventApiDestination test api-destination
* ```
*
*/
@ResourceType(type="aws:cloudwatch/eventApiDestination:EventApiDestination")
public class EventApiDestination extends com.pulumi.resources.CustomResource {
/**
* The Amazon Resource Name (ARN) of the event API Destination.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return The Amazon Resource Name (ARN) of the event API Destination.
*
*/
public Output arn() {
return this.arn;
}
/**
* ARN of the EventBridge Connection to use for the API Destination.
*
*/
@Export(name="connectionArn", refs={String.class}, tree="[0]")
private Output connectionArn;
/**
* @return ARN of the EventBridge Connection to use for the API Destination.
*
*/
public Output connectionArn() {
return this.connectionArn;
}
/**
* The description of the new API Destination. Maximum of 512 characters.
*
*/
@Export(name="description", refs={String.class}, tree="[0]")
private Output description;
/**
* @return The description of the new API Destination. Maximum of 512 characters.
*
*/
public Output> description() {
return Codegen.optional(this.description);
}
/**
* Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
*
*/
@Export(name="httpMethod", refs={String.class}, tree="[0]")
private Output httpMethod;
/**
* @return Select the HTTP method used for the invocation endpoint, such as GET, POST, PUT, etc.
*
*/
public Output httpMethod() {
return this.httpMethod;
}
/**
* 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.
*
*/
@Export(name="invocationEndpoint", refs={String.class}, tree="[0]")
private Output invocationEndpoint;
/**
* @return 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.
*
*/
public Output invocationEndpoint() {
return this.invocationEndpoint;
}
/**
* Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
*
*/
@Export(name="invocationRateLimitPerSecond", refs={Integer.class}, tree="[0]")
private Output invocationRateLimitPerSecond;
/**
* @return Enter the maximum number of invocations per second to allow for this destination. Enter a value greater than 0 (default 300).
*
*/
public Output> invocationRateLimitPerSecond() {
return Codegen.optional(this.invocationRateLimitPerSecond);
}
/**
* 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, .,-,_.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return 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, .,-,_.
*
*/
public Output name() {
return this.name;
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public EventApiDestination(java.lang.String name) {
this(name, EventApiDestinationArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public EventApiDestination(java.lang.String name, EventApiDestinationArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public EventApiDestination(java.lang.String name, EventApiDestinationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:cloudwatch/eventApiDestination:EventApiDestination", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private EventApiDestination(java.lang.String name, Output id, @Nullable EventApiDestinationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:cloudwatch/eventApiDestination:EventApiDestination", name, state, makeResourceOptions(options, id), false);
}
private static EventApiDestinationArgs makeArgs(EventApiDestinationArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? EventApiDestinationArgs.Empty : args;
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static EventApiDestination get(java.lang.String name, Output id, @Nullable EventApiDestinationState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new EventApiDestination(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy