@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
162 lines (161 loc) • 4.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Get information on an EC2 Transit Gateway Connect Peer.
*
* ## Example Usage
*
* ### By Filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2transitgateway.getConnectPeer({
* filters: [{
* name: "transit-gateway-attachment-id",
* values: ["tgw-attach-12345678"],
* }],
* });
* ```
*
* ### By Identifier
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2transitgateway.getConnectPeer({
* transitGatewayConnectPeerId: "tgw-connect-peer-12345678",
* });
* ```
*/
export declare function getConnectPeer(args?: GetConnectPeerArgs, opts?: pulumi.InvokeOptions): Promise<GetConnectPeerResult>;
/**
* A collection of arguments for invoking getConnectPeer.
*/
export interface GetConnectPeerArgs {
/**
* One or more configuration blocks containing name-values filters. Detailed below.
*/
filters?: inputs.ec2transitgateway.GetConnectPeerFilter[];
/**
* 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.
*/
region?: string;
/**
* Key-value tags for the EC2 Transit Gateway Connect Peer
*/
tags?: {
[key: string]: string;
};
/**
* Identifier of the EC2 Transit Gateway Connect Peer.
*/
transitGatewayConnectPeerId?: string;
}
/**
* A collection of values returned by getConnectPeer.
*/
export interface GetConnectPeerResult {
/**
* EC2 Transit Gateway Connect Peer ARN
*/
readonly arn: string;
/**
* BGP ASN number assigned customer device
*/
readonly bgpAsn: string;
/**
* The IP address assigned to customer device, which is used as BGP IP address.
*/
readonly bgpPeerAddress: string;
/**
* The IP addresses assigned to Transit Gateway, which are used as BGP IP addresses.
*/
readonly bgpTransitGatewayAddresses: string[];
readonly filters?: outputs.ec2transitgateway.GetConnectPeerFilter[];
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* CIDR blocks that will be used for addressing within the tunnel.
*/
readonly insideCidrBlocks: string[];
/**
* IP addressed assigned to customer device, which is used as tunnel endpoint
*/
readonly peerAddress: string;
readonly region: string;
/**
* Key-value tags for the EC2 Transit Gateway Connect Peer
*/
readonly tags: {
[key: string]: string;
};
/**
* The IP address assigned to Transit Gateway, which is used as tunnel endpoint.
*/
readonly transitGatewayAddress: string;
/**
* The Transit Gateway Connect
*/
readonly transitGatewayAttachmentId: string;
readonly transitGatewayConnectPeerId: string;
}
/**
* Get information on an EC2 Transit Gateway Connect Peer.
*
* ## Example Usage
*
* ### By Filter
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2transitgateway.getConnectPeer({
* filters: [{
* name: "transit-gateway-attachment-id",
* values: ["tgw-attach-12345678"],
* }],
* });
* ```
*
* ### By Identifier
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = aws.ec2transitgateway.getConnectPeer({
* transitGatewayConnectPeerId: "tgw-connect-peer-12345678",
* });
* ```
*/
export declare function getConnectPeerOutput(args?: GetConnectPeerOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetConnectPeerResult>;
/**
* A collection of arguments for invoking getConnectPeer.
*/
export interface GetConnectPeerOutputArgs {
/**
* One or more configuration blocks containing name-values filters. Detailed below.
*/
filters?: pulumi.Input<pulumi.Input<inputs.ec2transitgateway.GetConnectPeerFilterArgs>[]>;
/**
* 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.
*/
region?: pulumi.Input<string>;
/**
* Key-value tags for the EC2 Transit Gateway Connect Peer
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Identifier of the EC2 Transit Gateway Connect Peer.
*/
transitGatewayConnectPeerId?: pulumi.Input<string>;
}