AwsEventbridgeConnectionArgs

interface AwsEventbridgeConnectionArgs {
authorizationType: Input<'BASIC' | 'API_KEY' | 'OAUTH_CLIENT_CREDENTIALS'>;
authParameters: AwsEventbridgeConnectionAuthParametersArgs;
description?: Input<string>;
invocationConnectivityParameters?: AwsEventbridgeConnectionConnectivityParametersArgs;
kmsKey?: AwsKmsKeyInput;
name: string;
}

Input arguments for AwsEventbridgeConnection.

Remarks

authorizationType and authParameters are required. The Pulumi logical name derives from args.name as ${environmentCode}-${projectHash}-eventbridge-connection-${sanitisedName}. The AWS provider connection name derives explicitly from args.name via the naming-style prefix pattern.

Credentials and secret values are automatically stored and managed by AWS Secrets Manager. The ARN of the generated secret is available via AwsEventbridgeConnection.secretArn.

Note: EventConnection does not support resource-level tags in the Pulumi AWS provider.

Example

CODE

// BASIC auth
const conn = new AwsEventbridgeConnection({
  name: 'myApi',
  authorizationType: 'BASIC',
  authParameters: {
    basic: { username: 'user', password: 'Pass1234!' },
  },
  description: 'Connection to my API',
});

export const connArn = conn.arn;

CODE

// API key auth
const conn = new AwsEventbridgeConnection({
  name: 'myApi',
  authorizationType: 'API_KEY',
  authParameters: {
    apiKey: { key: 'x-api-key', value: 'supersecret' },
  },
});

CODE

// OAuth with client credentials
const conn = new AwsEventbridgeConnection({
  name: 'myOauthApi',
  authorizationType: 'OAUTH_CLIENT_CREDENTIALS',
  authParameters: {
    oauth: {
      authorizationEndpoint: 'https://auth.example.com/token',
      httpMethod: 'POST',
      oauthHttpParameters: {
        bodies: [{ key: 'grant_type', value: 'client_credentials' }],
      },
      clientParameters: {
        clientId: 'my-client-id',
        clientSecret: 'my-client-secret',
      },
    },
  },
});

export const secretArn = conn.secretArn;

Properties

`authorizationType: Input<'BASIC' | 'API_KEY' | 'OAUTH_CLIENT_CREDENTIALS'>`

Authorization type for the connection. Valid values: BASIC, API_KEY, OAUTH_CLIENT_CREDENTIALS.

`authParameters: AwsEventbridgeConnectionAuthParametersArgs`

`description: Input<string>`

Human-readable description of the connection. Maximum 512 characters.

`invocationConnectivityParameters: AwsEventbridgeConnectionConnectivityParametersArgs`

Connectivity parameters for invoking a private API endpoint via Amazon VPC Lattice. Use this to route invocations through a private network rather than the public internet.

`kmsKey: AwsKmsKeyInput`

Canonical AWS KMS customer-managed key reference used to encrypt the connection secrets. Use keyArn for a known ARN or identifier for a key ID, key ARN, alias, or alias ARN.