Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. events
  5. Connection

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.events.Connection

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Events::Connection.

    Example Usage

    Example

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AwsNative = Pulumi.AwsNative;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var pagerDutyAPIKeyParam = config.Require("pagerDutyAPIKeyParam");
    var myConnection = new AwsNative.Events.Connection("myConnection", new()
    {
        AuthorizationType = AwsNative.Events.ConnectionAuthorizationType.ApiKey,
        Description = "Connection to PagerDuty API",
        AuthParameters = new AwsNative.Events.Inputs.ConnectionAuthParametersArgs
        {
            ApiKeyAuthParameters = new AwsNative.Events.Inputs.ConnectionApiKeyAuthParametersArgs
            {
                ApiKeyName = "PagerDuty Authorization",
                ApiKeyValue = pagerDutyAPIKeyParam,
            },
        },
    });

    var myApiDestination = new AwsNative.Events.ApiDestination("myApiDestination", new()
    {
        ConnectionArn = myConnection.Arn,
        Description = "API Destination to send events to PagerDuty",
        HttpMethod = AwsNative.Events.ApiDestinationHttpMethod.Post,
        InvocationEndpoint = "https://events.pagerduty.com/v2/enqueue",
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws-native/sdk/go/aws/events"
	"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, "")
		pagerDutyAPIKeyParam := cfg.Require("pagerDutyAPIKeyParam")
		myConnection, err := events.NewConnection(ctx, "myConnection", &events.ConnectionArgs{
			AuthorizationType: events.ConnectionAuthorizationTypeApiKey,
			Description:       pulumi.String("Connection to PagerDuty API"),
			AuthParameters: &events.ConnectionAuthParametersArgs{
				ApiKeyAuthParameters: &events.ConnectionApiKeyAuthParametersArgs{
					ApiKeyName:  pulumi.String("PagerDuty Authorization"),
					ApiKeyValue: pulumi.String(pagerDutyAPIKeyParam),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = events.NewApiDestination(ctx, "myApiDestination", &events.ApiDestinationArgs{
			ConnectionArn:      myConnection.Arn,
			Description:        pulumi.String("API Destination to send events to PagerDuty"),
			HttpMethod:         events.ApiDestinationHttpMethodPost,
			InvocationEndpoint: pulumi.String("https://events.pagerduty.com/v2/enqueue"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    Coming soon!

    import pulumi
import pulumi_aws_native as aws_native

config = pulumi.Config()
pager_duty_api_key_param = config.require("pagerDutyAPIKeyParam")
my_connection = aws_native.events.Connection("myConnection",
    authorization_type=aws_native.events.ConnectionAuthorizationType.API_KEY,
    description="Connection to PagerDuty API",
    auth_parameters=aws_native.events.ConnectionAuthParametersArgs(
        api_key_auth_parameters=aws_native.events.ConnectionApiKeyAuthParametersArgs(
            api_key_name="PagerDuty Authorization",
            api_key_value=pager_duty_api_key_param,
        ),
    ))
my_api_destination = aws_native.events.ApiDestination("myApiDestination",
    connection_arn=my_connection.arn,
    description="API Destination to send events to PagerDuty",
    http_method=aws_native.events.ApiDestinationHttpMethod.POST,
    invocation_endpoint="https://events.pagerduty.com/v2/enqueue")

    import * as pulumi from "@pulumi/pulumi";
import * as aws_native from "@pulumi/aws-native";

const config = new pulumi.Config();
const pagerDutyAPIKeyParam = config.require("pagerDutyAPIKeyParam");
const myConnection = new aws_native.events.Connection("myConnection", {
    authorizationType: aws_native.events.ConnectionAuthorizationType.ApiKey,
    description: "Connection to PagerDuty API",
    authParameters: {
        apiKeyAuthParameters: {
            apiKeyName: "PagerDuty Authorization",
            apiKeyValue: pagerDutyAPIKeyParam,
        },
    },
});
const myApiDestination = new aws_native.events.ApiDestination("myApiDestination", {
    connectionArn: myConnection.arn,
    description: "API Destination to send events to PagerDuty",
    httpMethod: aws_native.events.ApiDestinationHttpMethod.Post,
    invocationEndpoint: "https://events.pagerduty.com/v2/enqueue",
});

    Coming soon!

    Create Connection Resource

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

    Constructor syntax

    new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
    @overload
def Connection(resource_name: str,
               args: ConnectionArgs,
               opts: Optional[ResourceOptions] = None)

@overload
def Connection(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               auth_parameters: Optional[ConnectionAuthParametersArgs] = None,
               authorization_type: Optional[ConnectionAuthorizationType] = None,
               description: Optional[str] = None,
               name: Optional[str] = None)
    func NewConnection(ctx *Context, name string, args ConnectionArgs, opts ...ResourceOption) (*Connection, error)
    public Connection(string name, ConnectionArgs args, CustomResourceOptions? opts = null)
    public Connection(String name, ConnectionArgs args)
public Connection(String name, ConnectionArgs args, CustomResourceOptions options)

    type: aws-native:events:Connection
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 ConnectionArgs
    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 ConnectionArgs
    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 ConnectionArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ConnectionArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Connection 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 Connection resource accepts the following input properties:

    AuthParameters Pulumi.AwsNative.Events.Inputs.ConnectionAuthParameters
    A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
    AuthorizationType Pulumi.AwsNative.Events.ConnectionAuthorizationType

    The type of authorization to use for the connection.

    OAUTH tokens are refreshed when a 401 or 407 response is returned.

    Description string
    Description of the connection.
    Name string
    Name of the connection.
    AuthParameters ConnectionAuthParametersArgs
    A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
    AuthorizationType ConnectionAuthorizationType

    The type of authorization to use for the connection.

    OAUTH tokens are refreshed when a 401 or 407 response is returned.

    Description string
    Description of the connection.
    Name string
    Name of the connection.
    authParameters ConnectionAuthParameters
    A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
    authorizationType ConnectionAuthorizationType

    The type of authorization to use for the connection.

    OAUTH tokens are refreshed when a 401 or 407 response is returned.

    description String
    Description of the connection.
    name String
    Name of the connection.
    authParameters ConnectionAuthParameters
    A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
    authorizationType ConnectionAuthorizationType

    The type of authorization to use for the connection.

    OAUTH tokens are refreshed when a 401 or 407 response is returned.

    description string
    Description of the connection.
    name string
    Name of the connection.
    auth_parameters ConnectionAuthParametersArgs
    A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
    authorization_type ConnectionAuthorizationType

    The type of authorization to use for the connection.

    OAUTH tokens are refreshed when a 401 or 407 response is returned.

    description str
    Description of the connection.
    name str
    Name of the connection.
    authParameters Property Map
    A CreateConnectionAuthRequestParameters object that contains the authorization parameters to use to authorize with the endpoint.
    authorizationType "API_KEY" | "BASIC" | "OAUTH_CLIENT_CREDENTIALS"

    The type of authorization to use for the connection.

    OAUTH tokens are refreshed when a 401 or 407 response is returned.

    description String
    Description of the connection.
    name String
    Name of the connection.

    Outputs

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

    Arn string
    The arn of the connection resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretArn string
    The arn of the secrets manager secret created in the customer account.
    Arn string
    The arn of the connection resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    SecretArn string
    The arn of the secrets manager secret created in the customer account.
    arn String
    The arn of the connection resource.
    id String
    The provider-assigned unique ID for this managed resource.
    secretArn String
    The arn of the secrets manager secret created in the customer account.
    arn string
    The arn of the connection resource.
    id string
    The provider-assigned unique ID for this managed resource.
    secretArn string
    The arn of the secrets manager secret created in the customer account.
    arn str
    The arn of the connection resource.
    id str
    The provider-assigned unique ID for this managed resource.
    secret_arn str
    The arn of the secrets manager secret created in the customer account.
    arn String
    The arn of the connection resource.
    id String
    The provider-assigned unique ID for this managed resource.
    secretArn String
    The arn of the secrets manager secret created in the customer account.

    Supporting Types

    ConnectionApiKeyAuthParameters, ConnectionApiKeyAuthParametersArgs

    ApiKeyName string
    The name of the API key to use for authorization.
    ApiKeyValue string
    The value for the API key to use for authorization.
    ApiKeyName string
    The name of the API key to use for authorization.
    ApiKeyValue string
    The value for the API key to use for authorization.
    apiKeyName String
    The name of the API key to use for authorization.
    apiKeyValue String
    The value for the API key to use for authorization.
    apiKeyName string
    The name of the API key to use for authorization.
    apiKeyValue string
    The value for the API key to use for authorization.
    api_key_name str
    The name of the API key to use for authorization.
    api_key_value str
    The value for the API key to use for authorization.
    apiKeyName String
    The name of the API key to use for authorization.
    apiKeyValue String
    The value for the API key to use for authorization.

    ConnectionAuthParameters, ConnectionAuthParametersArgs

    ApiKeyAuthParameters Pulumi.AwsNative.Events.Inputs.ConnectionApiKeyAuthParameters
    The API Key parameters to use for authorization.
    BasicAuthParameters Pulumi.AwsNative.Events.Inputs.ConnectionBasicAuthParameters
    The authorization parameters for Basic authorization.
    InvocationHttpParameters Pulumi.AwsNative.Events.Inputs.ConnectionHttpParameters
    Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
    OAuthParameters Pulumi.AwsNative.Events.Inputs.ConnectionOAuthParameters
    The OAuth parameters to use for authorization.
    ApiKeyAuthParameters ConnectionApiKeyAuthParameters
    The API Key parameters to use for authorization.
    BasicAuthParameters ConnectionBasicAuthParameters
    The authorization parameters for Basic authorization.
    InvocationHttpParameters ConnectionHttpParameters
    Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
    OAuthParameters ConnectionOAuthParameters
    The OAuth parameters to use for authorization.
    apiKeyAuthParameters ConnectionApiKeyAuthParameters
    The API Key parameters to use for authorization.
    basicAuthParameters ConnectionBasicAuthParameters
    The authorization parameters for Basic authorization.
    invocationHttpParameters ConnectionHttpParameters
    Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
    oAuthParameters ConnectionOAuthParameters
    The OAuth parameters to use for authorization.
    apiKeyAuthParameters ConnectionApiKeyAuthParameters
    The API Key parameters to use for authorization.
    basicAuthParameters ConnectionBasicAuthParameters
    The authorization parameters for Basic authorization.
    invocationHttpParameters ConnectionHttpParameters
    Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
    oAuthParameters ConnectionOAuthParameters
    The OAuth parameters to use for authorization.
    api_key_auth_parameters ConnectionApiKeyAuthParameters
    The API Key parameters to use for authorization.
    basic_auth_parameters ConnectionBasicAuthParameters
    The authorization parameters for Basic authorization.
    invocation_http_parameters ConnectionHttpParameters
    Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
    o_auth_parameters ConnectionOAuthParameters
    The OAuth parameters to use for authorization.
    apiKeyAuthParameters Property Map
    The API Key parameters to use for authorization.
    basicAuthParameters Property Map
    The authorization parameters for Basic authorization.
    invocationHttpParameters Property Map
    Additional parameters for the connection that are passed through with every invocation to the HTTP endpoint.
    oAuthParameters Property Map
    The OAuth parameters to use for authorization.

    ConnectionAuthorizationType, ConnectionAuthorizationTypeArgs

    ApiKey
    API_KEY
    Basic
    BASIC
    OauthClientCredentials
    OAUTH_CLIENT_CREDENTIALS
    ConnectionAuthorizationTypeApiKey
    API_KEY
    ConnectionAuthorizationTypeBasic
    BASIC
    ConnectionAuthorizationTypeOauthClientCredentials
    OAUTH_CLIENT_CREDENTIALS
    ApiKey
    API_KEY
    Basic
    BASIC
    OauthClientCredentials
    OAUTH_CLIENT_CREDENTIALS
    ApiKey
    API_KEY
    Basic
    BASIC
    OauthClientCredentials
    OAUTH_CLIENT_CREDENTIALS
    API_KEY
    API_KEY
    BASIC
    BASIC
    OAUTH_CLIENT_CREDENTIALS
    OAUTH_CLIENT_CREDENTIALS
    "API_KEY"
    API_KEY
    "BASIC"
    BASIC
    "OAUTH_CLIENT_CREDENTIALS"
    OAUTH_CLIENT_CREDENTIALS

    ConnectionBasicAuthParameters, ConnectionBasicAuthParametersArgs

    Password string
    The password associated with the user name to use for Basic authorization.
    Username string
    The user name to use for Basic authorization.
    Password string
    The password associated with the user name to use for Basic authorization.
    Username string
    The user name to use for Basic authorization.
    password String
    The password associated with the user name to use for Basic authorization.
    username String
    The user name to use for Basic authorization.
    password string
    The password associated with the user name to use for Basic authorization.
    username string
    The user name to use for Basic authorization.
    password str
    The password associated with the user name to use for Basic authorization.
    username str
    The user name to use for Basic authorization.
    password String
    The password associated with the user name to use for Basic authorization.
    username String
    The user name to use for Basic authorization.

    ConnectionClientParameters, ConnectionClientParametersArgs

    ClientId string
    The client ID to use for OAuth authorization.
    ClientSecret string
    The client secret assciated with the client ID to use for OAuth authorization.
    ClientId string
    The client ID to use for OAuth authorization.
    ClientSecret string
    The client secret assciated with the client ID to use for OAuth authorization.
    clientId String
    The client ID to use for OAuth authorization.
    clientSecret String
    The client secret assciated with the client ID to use for OAuth authorization.
    clientId string
    The client ID to use for OAuth authorization.
    clientSecret string
    The client secret assciated with the client ID to use for OAuth authorization.
    client_id str
    The client ID to use for OAuth authorization.
    client_secret str
    The client secret assciated with the client ID to use for OAuth authorization.
    clientId String
    The client ID to use for OAuth authorization.
    clientSecret String
    The client secret assciated with the client ID to use for OAuth authorization.

    ConnectionHttpParameters, ConnectionHttpParametersArgs

    BodyParameters List<Pulumi.AwsNative.Events.Inputs.ConnectionParameter>
    Contains additional body string parameters for the connection.
    HeaderParameters List<Pulumi.AwsNative.Events.Inputs.ConnectionParameter>
    Contains additional header parameters for the connection.
    QueryStringParameters List<Pulumi.AwsNative.Events.Inputs.ConnectionParameter>
    Contains additional query string parameters for the connection.
    BodyParameters []ConnectionParameter
    Contains additional body string parameters for the connection.
    HeaderParameters []ConnectionParameter
    Contains additional header parameters for the connection.
    QueryStringParameters []ConnectionParameter
    Contains additional query string parameters for the connection.
    bodyParameters List<ConnectionParameter>
    Contains additional body string parameters for the connection.
    headerParameters List<ConnectionParameter>
    Contains additional header parameters for the connection.
    queryStringParameters List<ConnectionParameter>
    Contains additional query string parameters for the connection.
    bodyParameters ConnectionParameter[]
    Contains additional body string parameters for the connection.
    headerParameters ConnectionParameter[]
    Contains additional header parameters for the connection.
    queryStringParameters ConnectionParameter[]
    Contains additional query string parameters for the connection.
    body_parameters Sequence[ConnectionParameter]
    Contains additional body string parameters for the connection.
    header_parameters Sequence[ConnectionParameter]
    Contains additional header parameters for the connection.
    query_string_parameters Sequence[ConnectionParameter]
    Contains additional query string parameters for the connection.
    bodyParameters List<Property Map>
    Contains additional body string parameters for the connection.
    headerParameters List<Property Map>
    Contains additional header parameters for the connection.
    queryStringParameters List<Property Map>
    Contains additional query string parameters for the connection.

    ConnectionOAuthParameters, ConnectionOAuthParametersArgs

    AuthorizationEndpoint string
    The URL to the authorization endpoint when OAuth is specified as the authorization type.
    ClientParameters Pulumi.AwsNative.Events.Inputs.ConnectionClientParameters
    A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.
    HttpMethod Pulumi.AwsNative.Events.ConnectionOAuthParametersHttpMethod
    The method to use for the authorization request.
    OAuthHttpParameters Pulumi.AwsNative.Events.Inputs.ConnectionHttpParameters
    A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.
    AuthorizationEndpoint string
    The URL to the authorization endpoint when OAuth is specified as the authorization type.
    ClientParameters ConnectionClientParameters
    A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.
    HttpMethod ConnectionOAuthParametersHttpMethod
    The method to use for the authorization request.
    OAuthHttpParameters ConnectionHttpParameters
    A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.
    authorizationEndpoint String
    The URL to the authorization endpoint when OAuth is specified as the authorization type.
    clientParameters ConnectionClientParameters
    A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.
    httpMethod ConnectionOAuthParametersHttpMethod
    The method to use for the authorization request.
    oAuthHttpParameters ConnectionHttpParameters
    A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.
    authorizationEndpoint string
    The URL to the authorization endpoint when OAuth is specified as the authorization type.
    clientParameters ConnectionClientParameters
    A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.
    httpMethod ConnectionOAuthParametersHttpMethod
    The method to use for the authorization request.
    oAuthHttpParameters ConnectionHttpParameters
    A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.
    authorization_endpoint str
    The URL to the authorization endpoint when OAuth is specified as the authorization type.
    client_parameters ConnectionClientParameters
    A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.
    http_method ConnectionOAuthParametersHttpMethod
    The method to use for the authorization request.
    o_auth_http_parameters ConnectionHttpParameters
    A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.
    authorizationEndpoint String
    The URL to the authorization endpoint when OAuth is specified as the authorization type.
    clientParameters Property Map
    A CreateConnectionOAuthClientRequestParameters object that contains the client parameters for OAuth authorization.
    httpMethod "GET" | "POST" | "PUT"
    The method to use for the authorization request.
    oAuthHttpParameters Property Map
    A ConnectionHttpParameters object that contains details about the additional parameters to use for the connection.

    ConnectionOAuthParametersHttpMethod, ConnectionOAuthParametersHttpMethodArgs

    Get
    GET
    Post
    POST
    Put
    PUT
    ConnectionOAuthParametersHttpMethodGet
    GET
    ConnectionOAuthParametersHttpMethodPost
    POST
    ConnectionOAuthParametersHttpMethodPut
    PUT
    Get
    GET
    Post
    POST
    Put
    PUT
    Get
    GET
    Post
    POST
    Put
    PUT
    GET
    GET
    POST
    POST
    PUT
    PUT
    "GET"
    GET
    "POST"
    POST
    "PUT"
    PUT

    ConnectionParameter, ConnectionParameterArgs

    Key string
    The key for a query string parameter.
    Value string
    The value associated with the key for the query string parameter.
    IsValueSecret bool
    Specifies whether the value is secret.
    Key string
    The key for a query string parameter.
    Value string
    The value associated with the key for the query string parameter.
    IsValueSecret bool
    Specifies whether the value is secret.
    key String
    The key for a query string parameter.
    value String
    The value associated with the key for the query string parameter.
    isValueSecret Boolean
    Specifies whether the value is secret.
    key string
    The key for a query string parameter.
    value string
    The value associated with the key for the query string parameter.
    isValueSecret boolean
    Specifies whether the value is secret.
    key str
    The key for a query string parameter.
    value str
    The value associated with the key for the query string parameter.
    is_value_secret bool
    Specifies whether the value is secret.
    key String
    The key for a query string parameter.
    value String
    The value associated with the key for the query string parameter.
    isValueSecret Boolean
    Specifies whether the value is secret.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.112.0 published on Wednesday, Jul 24, 2024 by Pulumi
    pulumi/pulumi-aws-native