@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
206 lines (205 loc) • 8.51 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a resource for managing a VPC (Virtual Private Cloud) Route Server.
*
* ## Example Usage
*
* ### Basic Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = new aws.vpc.RouteServer("test", {
* amazonSideAsn: 65534,
* tags: {
* Name: "Test",
* },
* });
* ```
*
* ### Persist Route and SNS Notification
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const test = new aws.vpc.RouteServer("test", {
* amazonSideAsn: 65534,
* persistRoutes: "enable",
* persistRoutesDuration: 2,
* snsNotificationsEnabled: true,
* tags: {
* Name: "Main Route Server",
* },
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import VPC (Virtual Private Cloud) Route Server using the `route_server_id`. For example:
*
* ```sh
* $ pulumi import aws:vpc/routeServer:RouteServer example rs-12345678
* ```
*/
export declare class RouteServer extends pulumi.CustomResource {
/**
* Get an existing RouteServer resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RouteServerState, opts?: pulumi.CustomResourceOptions): RouteServer;
/**
* Returns true if the given object is an instance of RouteServer. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is RouteServer;
/**
* The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.
*
* The following arguments are optional:
*/
readonly amazonSideAsn: pulumi.Output<number>;
/**
* The ARN of the route server.
*/
readonly arn: pulumi.Output<string>;
/**
* Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are `enable`, `disable`, `reset`
*/
readonly persistRoutes: pulumi.Output<string>;
/**
* The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if `persistRoutes` is enabled.
*/
readonly persistRoutesDuration: pulumi.Output<number | undefined>;
/**
* 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.
*/
readonly region: pulumi.Output<string>;
/**
* The unique identifier of the route server.
*/
readonly routeServerId: pulumi.Output<string>;
/**
* Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
*/
readonly snsNotificationsEnabled: pulumi.Output<boolean>;
/**
* The ARN of the SNS topic where notifications are published.
*/
readonly snsTopicArn: pulumi.Output<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
readonly timeouts: pulumi.Output<outputs.vpc.RouteServerTimeouts | undefined>;
/**
* Create a RouteServer resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: RouteServerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering RouteServer resources.
*/
export interface RouteServerState {
/**
* The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.
*
* The following arguments are optional:
*/
amazonSideAsn?: pulumi.Input<number>;
/**
* The ARN of the route server.
*/
arn?: pulumi.Input<string>;
/**
* Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are `enable`, `disable`, `reset`
*/
persistRoutes?: pulumi.Input<string>;
/**
* The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if `persistRoutes` is enabled.
*/
persistRoutesDuration?: pulumi.Input<number>;
/**
* 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>;
/**
* The unique identifier of the route server.
*/
routeServerId?: pulumi.Input<string>;
/**
* Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
*/
snsNotificationsEnabled?: pulumi.Input<boolean>;
/**
* The ARN of the SNS topic where notifications are published.
*/
snsTopicArn?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.vpc.RouteServerTimeouts>;
}
/**
* The set of arguments for constructing a RouteServer resource.
*/
export interface RouteServerArgs {
/**
* The Border Gateway Protocol (BGP) Autonomous System Number (ASN) for the appliance. Valid values are from 1 to 4294967295.
*
* The following arguments are optional:
*/
amazonSideAsn: pulumi.Input<number>;
/**
* Indicates whether routes should be persisted after all BGP sessions are terminated. Valid values are `enable`, `disable`, `reset`
*/
persistRoutes?: pulumi.Input<string>;
/**
* The number of minutes a route server will wait after BGP is re-established to unpersist the routes in the FIB and RIB. Value must be in the range of 1-5. Required if `persistRoutes` is enabled.
*/
persistRoutesDuration?: pulumi.Input<number>;
/**
* 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>;
/**
* Indicates whether SNS notifications should be enabled for route server events. Enabling SNS notifications persists BGP status changes to an SNS topic provisioned by AWS`.
*/
snsNotificationsEnabled?: pulumi.Input<boolean>;
/**
* A map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.vpc.RouteServerTimeouts>;
}