AWS Native is in preview. AWS Classic is fully supported.
aws-native.events.Connection
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
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
new Connection(name: string, args: ConnectionArgs, opts?: CustomResourceOptions);
@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)
@overload
def Connection(resource_name: str,
args: ConnectionArgs,
opts: Optional[ResourceOptions] = 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.
- 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:
- Auth
Parameters Pulumi.Aws Native. Events. Inputs. Connection Auth Parameters - Pulumi.
Aws Native. Events. Connection Authorization Type - Description string
Description of the connection.
- Name string
Name of the connection.
- Auth
Parameters ConnectionAuth Parameters Args - Connection
Authorization Type - Description string
Description of the connection.
- Name string
Name of the connection.
- auth
Parameters ConnectionAuth Parameters - Connection
Authorization Type - description String
Description of the connection.
- name String
Name of the connection.
- auth
Parameters ConnectionAuth Parameters - Connection
Authorization Type - description string
Description of the connection.
- name string
Name of the connection.
- auth_
parameters ConnectionAuth Parameters Args - Connection
Authorization Type - description str
Description of the connection.
- name str
Name of the connection.
- auth
Parameters Property Map - "API_KEY" | "BASIC" | "OAUTH_CLIENT_CREDENTIALS"
- 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 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.
Supporting Types
ConnectionApiKeyAuthParameters, ConnectionApiKeyAuthParametersArgs
- Api
Key stringName - Api
Key stringValue
- Api
Key stringName - Api
Key stringValue
- api
Key StringName - api
Key StringValue
- api
Key stringName - api
Key stringValue
- api_
key_ strname - api_
key_ strvalue
- api
Key StringName - api
Key StringValue
ConnectionAuthParameters, ConnectionAuthParametersArgs
- Api
Key Pulumi.Auth Parameters Aws Native. Events. Inputs. Connection Api Key Auth Parameters - Basic
Auth Pulumi.Parameters Aws Native. Events. Inputs. Connection Basic Auth Parameters - Invocation
Http Pulumi.Parameters Aws Native. Events. Inputs. Connection Http Parameters - OAuth
Parameters Pulumi.Aws Native. Events. Inputs. Connection OAuth Parameters
ConnectionAuthorizationType, ConnectionAuthorizationTypeArgs
- Api
Key - API_KEY
- Basic
- BASIC
- Oauth
Client Credentials - OAUTH_CLIENT_CREDENTIALS
- Connection
Authorization Type Api Key - API_KEY
- Connection
Authorization Type Basic - BASIC
- Connection
Authorization Type Oauth Client Credentials - 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
- 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
ConnectionClientParameters, ConnectionClientParametersArgs
- Client
Id string - Client
Secret string
- Client
Id string - Client
Secret string
- client
Id String - client
Secret String
- client
Id string - client
Secret string
- client_
id str - client_
secret str
- client
Id String - client
Secret String
ConnectionHttpParameters, ConnectionHttpParametersArgs
ConnectionOAuthParameters, ConnectionOAuthParametersArgs
ConnectionOAuthParametersHttpMethod, ConnectionOAuthParametersHttpMethodArgs
- Get
- GET
- Post
- POST
- Put
- PUT
- Connection
OAuth Parameters Http Method Get - GET
- Connection
OAuth Parameters Http Method Post - POST
- Connection
OAuth Parameters Http Method Put - 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
- Value string
- Is
Value boolSecret
- Key string
- Value string
- Is
Value boolSecret
- key String
- value String
- is
Value BooleanSecret
- key string
- value string
- is
Value booleanSecret
- key str
- value str
- is_
value_ boolsecret
- key String
- value String
- is
Value BooleanSecret
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.