com.pulumi.aws.ec2.kotlin.RouteTable.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-kotlin Show documentation
Show all versions of pulumi-aws-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.ec2.kotlin
import com.pulumi.aws.ec2.kotlin.outputs.RouteTableRoute
import com.pulumi.aws.ec2.kotlin.outputs.RouteTableRoute.Companion.toKotlin
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.Deprecated
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
/**
* Builder for [RouteTable].
*/
@PulumiTagMarker
public class RouteTableResourceBuilder internal constructor() {
public var name: String? = null
public var args: RouteTableArgs = RouteTableArgs()
public var opts: CustomResourceOptions = CustomResourceOptions()
/**
* @param name The _unique_ name of the resulting resource.
*/
public fun name(`value`: String) {
this.name = value
}
/**
* @param block The arguments to use to populate this resource's properties.
*/
public suspend fun args(block: suspend RouteTableArgsBuilder.() -> Unit) {
val builder = RouteTableArgsBuilder()
block(builder)
this.args = builder.build()
}
/**
* @param block A bag of options that control this resource's behavior.
*/
public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
}
internal fun build(): RouteTable {
val builtJavaResource = com.pulumi.aws.ec2.RouteTable(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return RouteTable(builtJavaResource)
}
}
/**
* Provides a resource to create a VPC routing table.
* > **NOTE on Route Tables and Routes:** This provider currently
* provides both a standalone Route resource and a Route Table resource with routes
* defined in-line. At this time you cannot use a Route Table with in-line routes
* in conjunction with any Route resources. Doing so will cause
* a conflict of rule settings and will overwrite rules.
* > **NOTE on `gateway_id` and `nat_gateway_id`:** The AWS API is very forgiving with these two
* attributes and the `aws.ec2.RouteTable` resource can be created with a NAT ID specified as a Gateway ID attribute.
* This _will_ lead to a permanent diff between your configuration and statefile, as the API returns the correct
* parameters in the returned route table. If you're experiencing constant diffs in your `aws.ec2.RouteTable` resources,
* the first thing to check is whether or not you're specifying a NAT ID instead of a Gateway ID, or vice-versa.
* > **NOTE on `propagating_vgws` and the `aws.ec2.VpnGatewayRoutePropagation` resource:**
* If the `propagating_vgws` argument is present, it's not supported to _also_
* define route propagations using `aws.ec2.VpnGatewayRoutePropagation`, since
* this resource will delete any propagating gateways not explicitly listed in
* `propagating_vgws`. Omit this argument when defining route propagation using
* the separate resource.
* ## Example Usage
* ### Basic example
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.ec2.RouteTable("example", {
* vpcId: exampleAwsVpc.id,
* routes: [
* {
* cidrBlock: "10.0.1.0/24",
* gatewayId: exampleAwsInternetGateway.id,
* },
* {
* ipv6CidrBlock: "::/0",
* egressOnlyGatewayId: exampleAwsEgressOnlyInternetGateway.id,
* },
* ],
* tags: {
* Name: "example",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.ec2.RouteTable("example",
* vpc_id=example_aws_vpc["id"],
* routes=[
* {
* "cidr_block": "10.0.1.0/24",
* "gateway_id": example_aws_internet_gateway["id"],
* },
* {
* "ipv6_cidr_block": "::/0",
* "egress_only_gateway_id": example_aws_egress_only_internet_gateway["id"],
* },
* ],
* tags={
* "Name": "example",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.Ec2.RouteTable("example", new()
* {
* VpcId = exampleAwsVpc.Id,
* Routes = new[]
* {
* new Aws.Ec2.Inputs.RouteTableRouteArgs
* {
* CidrBlock = "10.0.1.0/24",
* GatewayId = exampleAwsInternetGateway.Id,
* },
* new Aws.Ec2.Inputs.RouteTableRouteArgs
* {
* Ipv6CidrBlock = "::/0",
* EgressOnlyGatewayId = exampleAwsEgressOnlyInternetGateway.Id,
* },
* },
* Tags =
* {
* { "Name", "example" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := ec2.NewRouteTable(ctx, "example", &ec2.RouteTableArgs{
* VpcId: pulumi.Any(exampleAwsVpc.Id),
* Routes: ec2.RouteTableRouteArray{
* &ec2.RouteTableRouteArgs{
* CidrBlock: pulumi.String("10.0.1.0/24"),
* GatewayId: pulumi.Any(exampleAwsInternetGateway.Id),
* },
* &ec2.RouteTableRouteArgs{
* Ipv6CidrBlock: pulumi.String("::/0"),
* EgressOnlyGatewayId: pulumi.Any(exampleAwsEgressOnlyInternetGateway.Id),
* },
* },
* Tags: pulumi.StringMap{
* "Name": pulumi.String("example"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.ec2.RouteTable;
* import com.pulumi.aws.ec2.RouteTableArgs;
* import com.pulumi.aws.ec2.inputs.RouteTableRouteArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var example = new RouteTable("example", RouteTableArgs.builder()
* .vpcId(exampleAwsVpc.id())
* .routes(
* RouteTableRouteArgs.builder()
* .cidrBlock("10.0.1.0/24")
* .gatewayId(exampleAwsInternetGateway.id())
* .build(),
* RouteTableRouteArgs.builder()
* .ipv6CidrBlock("::/0")
* .egressOnlyGatewayId(exampleAwsEgressOnlyInternetGateway.id())
* .build())
* .tags(Map.of("Name", "example"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:ec2:RouteTable
* properties:
* vpcId: ${exampleAwsVpc.id}
* routes:
* - cidrBlock: 10.0.1.0/24
* gatewayId: ${exampleAwsInternetGateway.id}
* - ipv6CidrBlock: ::/0
* egressOnlyGatewayId: ${exampleAwsEgressOnlyInternetGateway.id}
* tags:
* Name: example
* ```
*
* To subsequently remove all managed routes:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const example = new aws.ec2.RouteTable("example", {
* vpcId: exampleAwsVpc.id,
* routes: [],
* tags: {
* Name: "example",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* example = aws.ec2.RouteTable("example",
* vpc_id=example_aws_vpc["id"],
* routes=[],
* tags={
* "Name": "example",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var example = new Aws.Ec2.RouteTable("example", new()
* {
* VpcId = exampleAwsVpc.Id,
* Routes = new[] {},
* Tags =
* {
* { "Name", "example" },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* _, err := ec2.NewRouteTable(ctx, "example", &ec2.RouteTableArgs{
* VpcId: pulumi.Any(exampleAwsVpc.Id),
* Routes: ec2.RouteTableRouteArray{},
* Tags: pulumi.StringMap{
* "Name": pulumi.String("example"),
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.ec2.RouteTable;
* import com.pulumi.aws.ec2.RouteTableArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var example = new RouteTable("example", RouteTableArgs.builder()
* .vpcId(exampleAwsVpc.id())
* .routes()
* .tags(Map.of("Name", "example"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* example:
* type: aws:ec2:RouteTable
* properties:
* vpcId: ${exampleAwsVpc.id}
* routes: []
* tags:
* Name: example
* ```
*
* ### Adopting an existing local route
* AWS creates certain routes that the AWS provider mostly ignores. You can manage them by importing or adopting them. See Import below for information on importing. This example shows adopting a route and then updating its target.
* First, adopt an existing AWS-created route:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const test = new aws.ec2.Vpc("test", {cidrBlock: "10.1.0.0/16"});
* const testRouteTable = new aws.ec2.RouteTable("test", {
* vpcId: test.id,
* routes: [{
* cidrBlock: "10.1.0.0/16",
* gatewayId: "local",
* }],
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* test = aws.ec2.Vpc("test", cidr_block="10.1.0.0/16")
* test_route_table = aws.ec2.RouteTable("test",
* vpc_id=test.id,
* routes=[{
* "cidr_block": "10.1.0.0/16",
* "gateway_id": "local",
* }])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var test = new Aws.Ec2.Vpc("test", new()
* {
* CidrBlock = "10.1.0.0/16",
* });
* var testRouteTable = new Aws.Ec2.RouteTable("test", new()
* {
* VpcId = test.Id,
* Routes = new[]
* {
* new Aws.Ec2.Inputs.RouteTableRouteArgs
* {
* CidrBlock = "10.1.0.0/16",
* GatewayId = "local",
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* test, err := ec2.NewVpc(ctx, "test", &ec2.VpcArgs{
* CidrBlock: pulumi.String("10.1.0.0/16"),
* })
* if err != nil {
* return err
* }
* _, err = ec2.NewRouteTable(ctx, "test", &ec2.RouteTableArgs{
* VpcId: test.ID(),
* Routes: ec2.RouteTableRouteArray{
* &ec2.RouteTableRouteArgs{
* CidrBlock: pulumi.String("10.1.0.0/16"),
* GatewayId: pulumi.String("local"),
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.ec2.Vpc;
* import com.pulumi.aws.ec2.VpcArgs;
* import com.pulumi.aws.ec2.RouteTable;
* import com.pulumi.aws.ec2.RouteTableArgs;
* import com.pulumi.aws.ec2.inputs.RouteTableRouteArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var test = new Vpc("test", VpcArgs.builder()
* .cidrBlock("10.1.0.0/16")
* .build());
* var testRouteTable = new RouteTable("testRouteTable", RouteTableArgs.builder()
* .vpcId(test.id())
* .routes(RouteTableRouteArgs.builder()
* .cidrBlock("10.1.0.0/16")
* .gatewayId("local")
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* test:
* type: aws:ec2:Vpc
* properties:
* cidrBlock: 10.1.0.0/16
* testRouteTable:
* type: aws:ec2:RouteTable
* name: test
* properties:
* vpcId: ${test.id}
* routes:
* - cidrBlock: 10.1.0.0/16
* gatewayId: local
* ```
*
* Next, update the target of the route:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const test = new aws.ec2.Vpc("test", {cidrBlock: "10.1.0.0/16"});
* const testSubnet = new aws.ec2.Subnet("test", {
* cidrBlock: "10.1.1.0/24",
* vpcId: test.id,
* });
* const testNetworkInterface = new aws.ec2.NetworkInterface("test", {subnetId: testSubnet.id});
* const testRouteTable = new aws.ec2.RouteTable("test", {
* vpcId: test.id,
* routes: [{
* cidrBlock: test.cidrBlock,
* networkInterfaceId: testNetworkInterface.id,
* }],
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* test = aws.ec2.Vpc("test", cidr_block="10.1.0.0/16")
* test_subnet = aws.ec2.Subnet("test",
* cidr_block="10.1.1.0/24",
* vpc_id=test.id)
* test_network_interface = aws.ec2.NetworkInterface("test", subnet_id=test_subnet.id)
* test_route_table = aws.ec2.RouteTable("test",
* vpc_id=test.id,
* routes=[{
* "cidr_block": test.cidr_block,
* "network_interface_id": test_network_interface.id,
* }])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var test = new Aws.Ec2.Vpc("test", new()
* {
* CidrBlock = "10.1.0.0/16",
* });
* var testSubnet = new Aws.Ec2.Subnet("test", new()
* {
* CidrBlock = "10.1.1.0/24",
* VpcId = test.Id,
* });
* var testNetworkInterface = new Aws.Ec2.NetworkInterface("test", new()
* {
* SubnetId = testSubnet.Id,
* });
* var testRouteTable = new Aws.Ec2.RouteTable("test", new()
* {
* VpcId = test.Id,
* Routes = new[]
* {
* new Aws.Ec2.Inputs.RouteTableRouteArgs
* {
* CidrBlock = test.CidrBlock,
* NetworkInterfaceId = testNetworkInterface.Id,
* },
* },
* });
* });
* ```
* ```go
* package main
* import (
* "github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
* "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
* )
* func main() {
* pulumi.Run(func(ctx *pulumi.Context) error {
* test, err := ec2.NewVpc(ctx, "test", &ec2.VpcArgs{
* CidrBlock: pulumi.String("10.1.0.0/16"),
* })
* if err != nil {
* return err
* }
* testSubnet, err := ec2.NewSubnet(ctx, "test", &ec2.SubnetArgs{
* CidrBlock: pulumi.String("10.1.1.0/24"),
* VpcId: test.ID(),
* })
* if err != nil {
* return err
* }
* testNetworkInterface, err := ec2.NewNetworkInterface(ctx, "test", &ec2.NetworkInterfaceArgs{
* SubnetId: testSubnet.ID(),
* })
* if err != nil {
* return err
* }
* _, err = ec2.NewRouteTable(ctx, "test", &ec2.RouteTableArgs{
* VpcId: test.ID(),
* Routes: ec2.RouteTableRouteArray{
* &ec2.RouteTableRouteArgs{
* CidrBlock: test.CidrBlock,
* NetworkInterfaceId: testNetworkInterface.ID(),
* },
* },
* })
* if err != nil {
* return err
* }
* return nil
* })
* }
* ```
* ```java
* package generated_program;
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.ec2.Vpc;
* import com.pulumi.aws.ec2.VpcArgs;
* import com.pulumi.aws.ec2.Subnet;
* import com.pulumi.aws.ec2.SubnetArgs;
* import com.pulumi.aws.ec2.NetworkInterface;
* import com.pulumi.aws.ec2.NetworkInterfaceArgs;
* import com.pulumi.aws.ec2.RouteTable;
* import com.pulumi.aws.ec2.RouteTableArgs;
* import com.pulumi.aws.ec2.inputs.RouteTableRouteArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
* public static void stack(Context ctx) {
* var test = new Vpc("test", VpcArgs.builder()
* .cidrBlock("10.1.0.0/16")
* .build());
* var testSubnet = new Subnet("testSubnet", SubnetArgs.builder()
* .cidrBlock("10.1.1.0/24")
* .vpcId(test.id())
* .build());
* var testNetworkInterface = new NetworkInterface("testNetworkInterface", NetworkInterfaceArgs.builder()
* .subnetId(testSubnet.id())
* .build());
* var testRouteTable = new RouteTable("testRouteTable", RouteTableArgs.builder()
* .vpcId(test.id())
* .routes(RouteTableRouteArgs.builder()
* .cidrBlock(test.cidrBlock())
* .networkInterfaceId(testNetworkInterface.id())
* .build())
* .build());
* }
* }
* ```
* ```yaml
* resources:
* test:
* type: aws:ec2:Vpc
* properties:
* cidrBlock: 10.1.0.0/16
* testRouteTable:
* type: aws:ec2:RouteTable
* name: test
* properties:
* vpcId: ${test.id}
* routes:
* - cidrBlock: ${test.cidrBlock}
* networkInterfaceId: ${testNetworkInterface.id}
* testSubnet:
* type: aws:ec2:Subnet
* name: test
* properties:
* cidrBlock: 10.1.1.0/24
* vpcId: ${test.id}
* testNetworkInterface:
* type: aws:ec2:NetworkInterface
* name: test
* properties:
* subnetId: ${testSubnet.id}
* ```
*
* The target could then be updated again back to `local`.
* ## Import
* Using `pulumi import`, import Route Tables using the route table `id`. For example:
* ```sh
* $ pulumi import aws:ec2/routeTable:RouteTable public_rt rtb-4e616f6d69
* ```
*/
public class RouteTable internal constructor(
override val javaResource: com.pulumi.aws.ec2.RouteTable,
) : KotlinCustomResource(javaResource, RouteTableMapper) {
/**
* The ARN of the route table.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The ID of the AWS account that owns the route table.
*/
public val ownerId: Output
get() = javaResource.ownerId().applyValue({ args0 -> args0 })
/**
* A list of virtual gateways for propagation.
*/
public val propagatingVgws: Output>
get() = javaResource.propagatingVgws().applyValue({ args0 -> args0.map({ args0 -> args0 }) })
/**
* A list of route objects. Their keys are documented below.
* This means that omitting this argument is interpreted as ignoring any existing routes. To remove all managed routes an empty list should be specified. See the example above.
*/
public val routes: Output>
get() = javaResource.routes().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
toKotlin(args0)
})
})
})
/**
* A map of tags to assign to the resource. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
}).orElse(null)
})
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*/
@Deprecated(
message = """
Please use `tags` instead.
""",
)
public val tagsAll: Output>
get() = javaResource.tagsAll().applyValue({ args0 ->
args0.map({ args0 ->
args0.key.to(args0.value)
}).toMap()
})
/**
* The VPC ID.
*/
public val vpcId: Output
get() = javaResource.vpcId().applyValue({ args0 -> args0 })
}
public object RouteTableMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.ec2.RouteTable::class == javaResource::class
override fun map(javaResource: Resource): RouteTable = RouteTable(
javaResource as
com.pulumi.aws.ec2.RouteTable,
)
}
/**
* @see [RouteTable].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [RouteTable].
*/
public suspend fun routeTable(name: String, block: suspend RouteTableResourceBuilder.() -> Unit): RouteTable {
val builder = RouteTableResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [RouteTable].
* @param name The _unique_ name of the resulting resource.
*/
public fun routeTable(name: String): RouteTable {
val builder = RouteTableResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy