@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
66 lines (65 loc) • 2.53 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Resource Type definition for AWS::Events::Connection.
*/
export declare function getConnection(args: GetConnectionArgs, opts?: pulumi.InvokeOptions): Promise<GetConnectionResult>;
export interface GetConnectionArgs {
/**
* Name of the connection.
*/
name: string;
}
export interface GetConnectionResult {
/**
* The arn of the connection resource.
*/
readonly arn?: string;
/**
* The arn of the connection resource to be used in IAM policies.
*/
readonly arnForPolicy?: string;
/**
* The authorization parameters to use to authorize with the endpoint.
*
* You must include only authorization parameters for the `AuthorizationType` you specify.
*/
readonly authParameters?: outputs.events.ConnectionAuthParameters;
/**
* The type of authorization to use for the connection.
*
* > OAUTH tokens are refreshed when a 401 or 407 response is returned.
*/
readonly authorizationType?: enums.events.ConnectionAuthorizationType;
/**
* Description of the connection.
*/
readonly description?: string;
/**
* The private resource the HTTP request will be sent to.
*/
readonly invocationConnectivityParameters?: outputs.events.InvocationConnectivityParametersProperties;
/**
* The identifier of the AWS 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 Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN.
*
* If you do not specify a customer managed key identifier, EventBridge uses an AWS owned key to encrypt the connection.
*
* For more information, see [Identify and view keys](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html) in the *AWS Key Management Service Developer Guide* .
*/
readonly kmsKeyIdentifier?: string;
/**
* The arn of the secrets manager secret created in the customer account.
*/
readonly secretArn?: string;
}
/**
* Resource Type definition for AWS::Events::Connection.
*/
export declare function getConnectionOutput(args: GetConnectionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConnectionResult>;
export interface GetConnectionOutputArgs {
/**
* Name of the connection.
*/
name: pulumi.Input<string>;
}