Class EventConnection


  • public class EventConnection
    extends com.pulumi.resources.CustomResource
    Provides an EventBridge connection 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.EventConnection;
     import com.pulumi.aws.cloudwatch.EventConnectionArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersApiKeyArgs;
     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 EventConnection("test", EventConnectionArgs.builder()
                 .authParameters(EventConnectionAuthParametersArgs.builder()
                     .apiKey(EventConnectionAuthParametersApiKeyArgs.builder()
                         .key("x-signature")
                         .value("1234")
                         .build())
                     .build())
                 .name("ngrok-connection")
                 .description("A connection description")
                 .authorizationType("API_KEY")
                 .build());
     
         }
     }
     
     
    ### Example Usage Basic Authorization
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.cloudwatch.EventConnection;
     import com.pulumi.aws.cloudwatch.EventConnectionArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersBasicArgs;
     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 EventConnection("test", EventConnectionArgs.builder()
                 .authParameters(EventConnectionAuthParametersArgs.builder()
                     .basic(EventConnectionAuthParametersBasicArgs.builder()
                         .username("user")
                         .password("Pass1234!")
                         .build())
                     .build())
                 .name("ngrok-connection")
                 .description("A connection description")
                 .authorizationType("BASIC")
                 .build());
     
         }
     }
     
     
    ### Example Usage OAuth Authorization
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.cloudwatch.EventConnection;
     import com.pulumi.aws.cloudwatch.EventConnectionArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthClientParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthOauthHttpParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthOauthHttpParametersBodyArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthOauthHttpParametersHeaderArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthOauthHttpParametersQueryStringArgs;
     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 EventConnection("test", EventConnectionArgs.builder()
                 .authParameters(EventConnectionAuthParametersArgs.builder()
                     .oauth(EventConnectionAuthParametersOauthArgs.builder()
                         .clientParameters(EventConnectionAuthParametersOauthClientParametersArgs.builder()
                             .clientId("1234567890")
                             .clientSecret("Pass1234!")
                             .build())
                         .oauthHttpParameters(EventConnectionAuthParametersOauthOauthHttpParametersArgs.builder()
                             .bodies(EventConnectionAuthParametersOauthOauthHttpParametersBodyArgs.builder()
                                 .key("body-parameter-key")
                                 .value("body-parameter-value")
                                 .isValueSecret(false)
                                 .build())
                             .headers(EventConnectionAuthParametersOauthOauthHttpParametersHeaderArgs.builder()
                                 .key("header-parameter-key")
                                 .value("header-parameter-value")
                                 .isValueSecret(false)
                                 .build())
                             .queryStrings(EventConnectionAuthParametersOauthOauthHttpParametersQueryStringArgs.builder()
                                 .key("query-string-parameter-key")
                                 .value("query-string-parameter-value")
                                 .isValueSecret(false)
                                 .build())
                             .build())
                         .authorizationEndpoint("https://auth.url.com/endpoint")
                         .httpMethod("GET")
                         .build())
                     .build())
                 .name("ngrok-connection")
                 .description("A connection description")
                 .authorizationType("OAUTH_CLIENT_CREDENTIALS")
                 .build());
     
         }
     }
     
     
    ### Example Usage Invocation HTTP Parameters
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.cloudwatch.EventConnection;
     import com.pulumi.aws.cloudwatch.EventConnectionArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersBasicArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersInvocationHttpParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersInvocationHttpParametersBodyArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersInvocationHttpParametersHeaderArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersInvocationHttpParametersQueryStringArgs;
     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 EventConnection("test", EventConnectionArgs.builder()
                 .authParameters(EventConnectionAuthParametersArgs.builder()
                     .basic(EventConnectionAuthParametersBasicArgs.builder()
                         .username("user")
                         .password("Pass1234!")
                         .build())
                     .invocationHttpParameters(EventConnectionAuthParametersInvocationHttpParametersArgs.builder()
                         .bodies(                    
                             EventConnectionAuthParametersInvocationHttpParametersBodyArgs.builder()
                                 .key("body-parameter-key")
                                 .value("body-parameter-value")
                                 .isValueSecret(false)
                                 .build(),
                             EventConnectionAuthParametersInvocationHttpParametersBodyArgs.builder()
                                 .key("body-parameter-key2")
                                 .value("body-parameter-value2")
                                 .isValueSecret(true)
                                 .build())
                         .headers(EventConnectionAuthParametersInvocationHttpParametersHeaderArgs.builder()
                             .key("header-parameter-key")
                             .value("header-parameter-value")
                             .isValueSecret(false)
                             .build())
                         .queryStrings(EventConnectionAuthParametersInvocationHttpParametersQueryStringArgs.builder()
                             .key("query-string-parameter-key")
                             .value("query-string-parameter-value")
                             .isValueSecret(false)
                             .build())
                         .build())
                     .build())
                 .name("ngrok-connection")
                 .description("A connection description")
                 .authorizationType("BASIC")
                 .build());
     
         }
     }
     
     
    ### Example Usage OAuth Authorization with Connectivity Parameters
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.cloudwatch.EventConnection;
     import com.pulumi.aws.cloudwatch.EventConnectionArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersConnectivityParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersConnectivityParametersResourceParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthClientParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthOauthHttpParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersOauthOauthHttpParametersBodyArgs;
     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 EventConnection("test", EventConnectionArgs.builder()
                 .authParameters(EventConnectionAuthParametersArgs.builder()
                     .connectivityParameters(EventConnectionAuthParametersConnectivityParametersArgs.builder()
                         .resourceParameters(EventConnectionAuthParametersConnectivityParametersResourceParametersArgs.builder()
                             .resourceConfigurationArn("arn:aws:vpc-lattice:us-east-1:12345678910:resourceconfiguration/rcfg-12345678910")
                             .build())
                         .build())
                     .oauth(EventConnectionAuthParametersOauthArgs.builder()
                         .clientParameters(EventConnectionAuthParametersOauthClientParametersArgs.builder()
                             .clientId("1234567890")
                             .clientSecret("Pass1234!")
                             .build())
                         .oauthHttpParameters(EventConnectionAuthParametersOauthOauthHttpParametersArgs.builder()
                             .bodies(EventConnectionAuthParametersOauthOauthHttpParametersBodyArgs.builder()
                                 .key("grant_type")
                                 .value("client_credentials")
                                 .isValueSecret(false)
                                 .build())
                             .build())
                         .authorizationEndpoint("https://private-api.example.com/auth")
                         .httpMethod("POST")
                         .build())
                     .build())
                 .name("private-api-connection")
                 .description("A connection to a private API")
                 .authorizationType("OAUTH_CLIENT_CREDENTIALS")
                 .build());
     
         }
     }
     
     
    ### Example Usage CMK Encryption
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.AwsFunctions;
     import com.pulumi.aws.inputs.GetCallerIdentityArgs;
     import com.pulumi.aws.inputs.GetPartitionArgs;
     import com.pulumi.aws.kms.Key;
     import com.pulumi.aws.kms.KeyArgs;
     import com.pulumi.aws.cloudwatch.EventConnection;
     import com.pulumi.aws.cloudwatch.EventConnectionArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersArgs;
     import com.pulumi.aws.cloudwatch.inputs.EventConnectionAuthParametersBasicArgs;
     import static com.pulumi.codegen.internal.Serialization.*;
     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) {
             final var current = AwsFunctions.getCallerIdentity(GetCallerIdentityArgs.builder()
                 .build());
     
             final var currentGetPartition = AwsFunctions.getPartition(GetPartitionArgs.builder()
                 .build());
     
             var test = new Key("test", KeyArgs.builder()
                 .deletionWindowInDays(7)
                 .policy(serializeJson(
                     jsonObject(
                         jsonProperty("Version", "2012-10-17"),
                         jsonProperty("Id", "key-policy-example"),
                         jsonProperty("Statement", jsonArray(
                             jsonObject(
                                 jsonProperty("Sid", "Enable IAM User Permissions"),
                                 jsonProperty("Effect", "Allow"),
                                 jsonProperty("Principal", jsonObject(
                                     jsonProperty("AWS", String.format("arn:%s:iam::%s:root", currentGetPartition.partition(),current.accountId()))
                                 )),
                                 jsonProperty("Action", "kms:*"),
                                 jsonProperty("Resource", "*")
                             ), 
                             jsonObject(
                                 jsonProperty("Sid", "Allow use of the key"),
                                 jsonProperty("Effect", "Allow"),
                                 jsonProperty("Principal", jsonObject(
                                     jsonProperty("AWS", String.format("arn:%s:iam::%s:root", currentGetPartition.partition(),current.accountId()))
                                 )),
                                 jsonProperty("Action", jsonArray(
                                     "kms:DescribeKey", 
                                     "kms:Decrypt", 
                                     "kms:GenerateDataKey"
                                 )),
                                 jsonProperty("Resource", "*"),
                                 jsonProperty("Condition", jsonObject(
                                     jsonProperty("StringLike", jsonObject(
                                         jsonProperty("kms:ViaService", "secretsmanager.*.amazonaws.com"),
                                         jsonProperty("kms:EncryptionContext:SecretARN", jsonArray("arn:aws:secretsmanager:*:*:secret:events!connection/*"))
                                     ))
                                 ))
                             )
                         ))
                     )))
                 .tags(Map.of("EventBridgeApiDestinations", "true"))
                 .build());
     
             var testEventConnection = new EventConnection("testEventConnection", EventConnectionArgs.builder()
                 .authParameters(EventConnectionAuthParametersArgs.builder()
                     .basic(EventConnectionAuthParametersBasicArgs.builder()
                         .username("user")
                         .password("Pass1234!")
                         .build())
                     .build())
                 .name("ngrok-connection")
                 .description("A connection description")
                 .authorizationType("BASIC")
                 .kmsKeyIdentifier(example.id())
                 .build());
     
         }
     }
     
     
    ## Import ### Identity Schema #### Required * `name` (String) Name of the connection. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Connections using `name`. For example: ```sh $ pulumi import aws:cloudwatch/eventConnection:EventConnection example example-connection ```
    • 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> authorizationType()  
      com.pulumi.core.Output<EventConnectionAuthParameters> authParameters()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static EventConnection get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, EventConnectionState 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.util.Optional<EventConnectionInvocationConnectivityParameters>> invocationConnectivityParameters()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyIdentifier()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> secretArn()  
      • 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

      • EventConnection

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

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

        public EventConnection​(java.lang.String name,
                               EventConnectionArgs 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 connection.
      • authParameters

        public com.pulumi.core.Output<EventConnectionAuthParameters> authParameters()
        Returns:
        Parameters used for authorization. A maximum of 1 are allowed. Documented below.
      • authorizationType

        public com.pulumi.core.Output<java.lang.String> authorizationType()
        Returns:
        Type of authorization to use for the connection. One of `API_KEY`,`BASIC`,`OAUTH_CLIENT_CREDENTIALS`.
      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description for the connection. Maximum of 512 characters.
      • invocationConnectivityParameters

        public com.pulumi.core.Output<java.util.Optional<EventConnectionInvocationConnectivityParameters>> invocationConnectivityParameters()
        Returns:
        Parameters to use for invoking a private API. Documented below.
      • kmsKeyIdentifier

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> kmsKeyIdentifier()
        Returns:
        Identifier of the AWS KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt this connection. The identifier can be the key ARN, KeyId, key alias, or key alias ARN.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        The name for the connection. 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.
      • secretArn

        public com.pulumi.core.Output<java.lang.String> secretArn()
        Returns:
        ARN of the secret created from the authorization parameters specified for the connection.
      • get

        public static EventConnection get​(java.lang.String name,
                                          com.pulumi.core.Output<java.lang.String> id,
                                          @Nullable
                                          EventConnectionState 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.