com.pulumi.aws.vpc.EndpointPrivateDns Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
There is a newer version: 6.72.0
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***

package com.pulumi.aws.vpc;

import com.pulumi.aws.Utilities;
import com.pulumi.aws.vpc.EndpointPrivateDnsArgs;
import com.pulumi.aws.vpc.inputs.EndpointPrivateDnsState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.Boolean;
import java.lang.String;
import javax.annotation.Nullable;

/**
 * Resource for enabling private DNS on an AWS VPC (Virtual Private Cloud) Endpoint.
 * 
 * > When using this resource, the `private_dns_enabled` argument should be omitted on the parent `aws.ec2.VpcEndpoint` resource.
 * Setting the value both places can lead to unintended behavior and persistent differences.
 * 
 * ## Example Usage
 * 
 * ### Basic Usage
 * 
 * <!--Start PulumiCodeChooser -->
 *  * {@code
 * package generated_program;
 * 
 * import com.pulumi.Context;
 * import com.pulumi.Pulumi;
 * import com.pulumi.core.Output;
 * import com.pulumi.aws.vpc.EndpointPrivateDns;
 * import com.pulumi.aws.vpc.EndpointPrivateDnsArgs;
 * 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 EndpointPrivateDns("example", EndpointPrivateDnsArgs.builder()
 *             .vpcEndpointId(exampleAwsVpcEndpoint.id())
 *             .privateDnsEnabled(true)
 *             .build());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 * ## Import
 * 
 * Using `pulumi import`, import a VPC (Virtual Private Cloud) Endpoint Private DNS using the `vpc_endpoint_id`. For example:
 * 
 * ```sh
 * $ pulumi import aws:vpc/endpointPrivateDns:EndpointPrivateDns example vpce-abcd-1234
 * ```
 * 
 */
@ResourceType(type="aws:vpc/endpointPrivateDns:EndpointPrivateDns")
public class EndpointPrivateDns extends com.pulumi.resources.CustomResource {
    /**
     * Indicates whether a private hosted zone is associated with the VPC. Only applicable for `Interface` endpoints.
     * 
     */
    @Export(name="privateDnsEnabled", refs={Boolean.class}, tree="[0]")
    private Output privateDnsEnabled;

    /**
     * @return Indicates whether a private hosted zone is associated with the VPC. Only applicable for `Interface` endpoints.
     * 
     */
    public Output privateDnsEnabled() {
        return this.privateDnsEnabled;
    }
    /**
     * VPC endpoint identifier.
     * 
     */
    @Export(name="vpcEndpointId", refs={String.class}, tree="[0]")
    private Output vpcEndpointId;

    /**
     * @return VPC endpoint identifier.
     * 
     */
    public Output vpcEndpointId() {
        return this.vpcEndpointId;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public EndpointPrivateDns(java.lang.String name) {
        this(name, EndpointPrivateDnsArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public EndpointPrivateDns(java.lang.String name, EndpointPrivateDnsArgs args) {
        this(name, args, null);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     * @param options A bag of options that control this resource's behavior.
     */
    public EndpointPrivateDns(java.lang.String name, EndpointPrivateDnsArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:vpc/endpointPrivateDns:EndpointPrivateDns", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private EndpointPrivateDns(java.lang.String name, Output id, @Nullable EndpointPrivateDnsState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:vpc/endpointPrivateDns:EndpointPrivateDns", name, state, makeResourceOptions(options, id), false);
    }

    private static EndpointPrivateDnsArgs makeArgs(EndpointPrivateDnsArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? EndpointPrivateDnsArgs.Empty : args;
    }

    private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
        var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
            .version(Utilities.getVersion())
            .build();
        return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
    }

    /**
     * Get an existing Host 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
     * @param options Optional settings to control the behavior of the CustomResource.
     */
    public static EndpointPrivateDns get(java.lang.String name, Output id, @Nullable EndpointPrivateDnsState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new EndpointPrivateDns(name, id, state, options);
    }
}