com.pulumi.aws.ec2.kotlin.VpcDhcpOptions.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.aws.ec2.kotlin
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 [VpcDhcpOptions].
*/
@PulumiTagMarker
public class VpcDhcpOptionsResourceBuilder internal constructor() {
public var name: String? = null
public var args: VpcDhcpOptionsArgs = VpcDhcpOptionsArgs()
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 VpcDhcpOptionsArgsBuilder.() -> Unit) {
val builder = VpcDhcpOptionsArgsBuilder()
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(): VpcDhcpOptions {
val builtJavaResource = com.pulumi.aws.ec2.VpcDhcpOptions(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return VpcDhcpOptions(builtJavaResource)
}
}
/**
* Provides a VPC DHCP Options resource.
* ## Example Usage
* Basic usage:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const dnsResolver = new aws.ec2.VpcDhcpOptions("dns_resolver", {domainNameServers: [
* "8.8.8.8",
* "8.8.4.4",
* ]});
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* dns_resolver = aws.ec2.VpcDhcpOptions("dns_resolver", domain_name_servers=[
* "8.8.8.8",
* "8.8.4.4",
* ])
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var dnsResolver = new Aws.Ec2.VpcDhcpOptions("dns_resolver", new()
* {
* DomainNameServers = new[]
* {
* "8.8.8.8",
* "8.8.4.4",
* },
* });
* });
* ```
* ```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.NewVpcDhcpOptions(ctx, "dns_resolver", &ec2.VpcDhcpOptionsArgs{
* DomainNameServers: pulumi.StringArray{
* pulumi.String("8.8.8.8"),
* pulumi.String("8.8.4.4"),
* },
* })
* 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.VpcDhcpOptions;
* import com.pulumi.aws.ec2.VpcDhcpOptionsArgs;
* 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 dnsResolver = new VpcDhcpOptions("dnsResolver", VpcDhcpOptionsArgs.builder()
* .domainNameServers(
* "8.8.8.8",
* "8.8.4.4")
* .build());
* }
* }
* ```
* ```yaml
* resources:
* dnsResolver:
* type: aws:ec2:VpcDhcpOptions
* name: dns_resolver
* properties:
* domainNameServers:
* - 8.8.8.8
* - 8.8.4.4
* ```
*
* Full usage:
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
* const foo = new aws.ec2.VpcDhcpOptions("foo", {
* domainName: "service.consul",
* domainNameServers: [
* "127.0.0.1",
* "10.0.0.2",
* ],
* ipv6AddressPreferredLeaseTime: "1440",
* ntpServers: ["127.0.0.1"],
* netbiosNameServers: ["127.0.0.1"],
* netbiosNodeType: "2",
* tags: {
* Name: "foo-name",
* },
* });
* ```
* ```python
* import pulumi
* import pulumi_aws as aws
* foo = aws.ec2.VpcDhcpOptions("foo",
* domain_name="service.consul",
* domain_name_servers=[
* "127.0.0.1",
* "10.0.0.2",
* ],
* ipv6_address_preferred_lease_time="1440",
* ntp_servers=["127.0.0.1"],
* netbios_name_servers=["127.0.0.1"],
* netbios_node_type="2",
* tags={
* "Name": "foo-name",
* })
* ```
* ```csharp
* using System.Collections.Generic;
* using System.Linq;
* using Pulumi;
* using Aws = Pulumi.Aws;
* return await Deployment.RunAsync(() =>
* {
* var foo = new Aws.Ec2.VpcDhcpOptions("foo", new()
* {
* DomainName = "service.consul",
* DomainNameServers = new[]
* {
* "127.0.0.1",
* "10.0.0.2",
* },
* Ipv6AddressPreferredLeaseTime = "1440",
* NtpServers = new[]
* {
* "127.0.0.1",
* },
* NetbiosNameServers = new[]
* {
* "127.0.0.1",
* },
* NetbiosNodeType = "2",
* Tags =
* {
* { "Name", "foo-name" },
* },
* });
* });
* ```
* ```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.NewVpcDhcpOptions(ctx, "foo", &ec2.VpcDhcpOptionsArgs{
* DomainName: pulumi.String("service.consul"),
* DomainNameServers: pulumi.StringArray{
* pulumi.String("127.0.0.1"),
* pulumi.String("10.0.0.2"),
* },
* Ipv6AddressPreferredLeaseTime: pulumi.String("1440"),
* NtpServers: pulumi.StringArray{
* pulumi.String("127.0.0.1"),
* },
* NetbiosNameServers: pulumi.StringArray{
* pulumi.String("127.0.0.1"),
* },
* NetbiosNodeType: pulumi.String("2"),
* Tags: pulumi.StringMap{
* "Name": pulumi.String("foo-name"),
* },
* })
* 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.VpcDhcpOptions;
* import com.pulumi.aws.ec2.VpcDhcpOptionsArgs;
* 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 foo = new VpcDhcpOptions("foo", VpcDhcpOptionsArgs.builder()
* .domainName("service.consul")
* .domainNameServers(
* "127.0.0.1",
* "10.0.0.2")
* .ipv6AddressPreferredLeaseTime(1440)
* .ntpServers("127.0.0.1")
* .netbiosNameServers("127.0.0.1")
* .netbiosNodeType(2)
* .tags(Map.of("Name", "foo-name"))
* .build());
* }
* }
* ```
* ```yaml
* resources:
* foo:
* type: aws:ec2:VpcDhcpOptions
* properties:
* domainName: service.consul
* domainNameServers:
* - 127.0.0.1
* - 10.0.0.2
* ipv6AddressPreferredLeaseTime: 1440
* ntpServers:
* - 127.0.0.1
* netbiosNameServers:
* - 127.0.0.1
* netbiosNodeType: 2
* tags:
* Name: foo-name
* ```
*
* ## Remarks
* * Notice that all arguments are optional but you have to specify at least one argument.
* * `domain_name_servers`, `netbios_name_servers`, `ntp_servers` are limited by AWS to maximum four servers only.
* * To actually use the DHCP Options Set you need to associate it to a VPC using `aws.ec2.VpcDhcpOptionsAssociation`.
* * If you delete a DHCP Options Set, all VPCs using it will be associated to AWS's `default` DHCP Option Set.
* * In most cases unless you're configuring your own DNS you'll want to set `domain_name_servers` to `AmazonProvidedDNS`.
* ## Import
* Using `pulumi import`, import VPC DHCP Options using the DHCP Options `id`. For example:
* ```sh
* $ pulumi import aws:ec2/vpcDhcpOptions:VpcDhcpOptions my_options dopt-d9070ebb
* ```
*/
public class VpcDhcpOptions internal constructor(
override val javaResource: com.pulumi.aws.ec2.VpcDhcpOptions,
) : KotlinCustomResource(javaResource, VpcDhcpOptionsMapper) {
/**
* The ARN of the DHCP Options Set.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* the suffix domain name to use by default when resolving non Fully Qualified Domain Names. In other words, this is what ends up being the `search` value in the `/etc/resolv.conf` file.
*/
public val domainName: Output?
get() = javaResource.domainName().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* List of name servers to configure in `/etc/resolv.conf`. If you want to use the default AWS nameservers you should set this to `AmazonProvidedDNS`.
*/
public val domainNameServers: Output>?
get() = javaResource.domainNameServers().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0 })
}).orElse(null)
})
/**
* How frequently, in seconds, a running instance with an IPv6 assigned to it goes through DHCPv6 lease renewal. Acceptable values are between 140 and 2147483647 (approximately 68 years). If no value is entered, the default lease time is 140 seconds. If you use long-term addressing for EC2 instances, you can increase the lease time and avoid frequent lease renewal requests. Lease renewal typically occurs when half of the lease time has elapsed.
*/
public val ipv6AddressPreferredLeaseTime: Output?
get() = javaResource.ipv6AddressPreferredLeaseTime().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* List of NETBIOS name servers.
*/
public val netbiosNameServers: Output>?
get() = javaResource.netbiosNameServers().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 -> args0 })
}).orElse(null)
})
/**
* The NetBIOS node type (1, 2, 4, or 8). AWS recommends to specify 2 since broadcast and multicast are not supported in their network. For more information about these node types, see [RFC 2132](http://www.ietf.org/rfc/rfc2132.txt).
*/
public val netbiosNodeType: Output?
get() = javaResource.netbiosNodeType().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
/**
* List of NTP servers to configure.
*/
public val ntpServers: Output>?
get() = javaResource.ntpServers().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* The ID of the AWS account that owns the DHCP options set.
*/
public val ownerId: Output
get() = javaResource.ownerId().applyValue({ args0 -> 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()
})
}
public object VpcDhcpOptionsMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.aws.ec2.VpcDhcpOptions::class == javaResource::class
override fun map(javaResource: Resource): VpcDhcpOptions = VpcDhcpOptions(
javaResource as
com.pulumi.aws.ec2.VpcDhcpOptions,
)
}
/**
* @see [VpcDhcpOptions].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [VpcDhcpOptions].
*/
public suspend fun vpcDhcpOptions(
name: String,
block: suspend VpcDhcpOptionsResourceBuilder.() -> Unit,
): VpcDhcpOptions {
val builder = VpcDhcpOptionsResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [VpcDhcpOptions].
* @param name The _unique_ name of the resulting resource.
*/
public fun vpcDhcpOptions(name: String): VpcDhcpOptions {
val builder = VpcDhcpOptionsResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy