com.pulumi.aws.directconnect.PrivateVirtualInterface Maven / Gradle / Ivy
// *** 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.directconnect;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.directconnect.PrivateVirtualInterfaceArgs;
import com.pulumi.aws.directconnect.inputs.PrivateVirtualInterfaceState;
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.Integer;
import java.lang.String;
import java.util.Map;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a Direct Connect private virtual interface resource.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.directconnect.PrivateVirtualInterface;
* import com.pulumi.aws.directconnect.PrivateVirtualInterfaceArgs;
* 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 PrivateVirtualInterface("foo", PrivateVirtualInterfaceArgs.builder()
* .connectionId("dxcon-zzzzzzzz")
* .name("vif-foo")
* .vlan(4094)
* .addressFamily("ipv4")
* .bgpAsn(65352)
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import Direct Connect private virtual interfaces using the VIF `id`. For example:
*
* ```sh
* $ pulumi import aws:directconnect/privateVirtualInterface:PrivateVirtualInterface test dxvif-33cc44dd
* ```
*
*/
@ResourceType(type="aws:directconnect/privateVirtualInterface:PrivateVirtualInterface")
public class PrivateVirtualInterface extends com.pulumi.resources.CustomResource {
/**
* The address family for the BGP peer. ` ipv4 ` or `ipv6`.
*
*/
@Export(name="addressFamily", refs={String.class}, tree="[0]")
private Output addressFamily;
/**
* @return The address family for the BGP peer. ` ipv4 ` or `ipv6`.
*
*/
public Output addressFamily() {
return this.addressFamily;
}
/**
* The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
*
*/
@Export(name="amazonAddress", refs={String.class}, tree="[0]")
private Output amazonAddress;
/**
* @return The IPv4 CIDR address to use to send traffic to Amazon. Required for IPv4 BGP peers.
*
*/
public Output amazonAddress() {
return this.amazonAddress;
}
@Export(name="amazonSideAsn", refs={String.class}, tree="[0]")
private Output amazonSideAsn;
public Output amazonSideAsn() {
return this.amazonSideAsn;
}
/**
* The ARN of the virtual interface.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return The ARN of the virtual interface.
*
*/
public Output arn() {
return this.arn;
}
/**
* The Direct Connect endpoint on which the virtual interface terminates.
*
*/
@Export(name="awsDevice", refs={String.class}, tree="[0]")
private Output awsDevice;
/**
* @return The Direct Connect endpoint on which the virtual interface terminates.
*
*/
public Output awsDevice() {
return this.awsDevice;
}
/**
* The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
*
*/
@Export(name="bgpAsn", refs={Integer.class}, tree="[0]")
private Output bgpAsn;
/**
* @return The autonomous system (AS) number for Border Gateway Protocol (BGP) configuration.
*
*/
public Output bgpAsn() {
return this.bgpAsn;
}
/**
* The authentication key for BGP configuration.
*
*/
@Export(name="bgpAuthKey", refs={String.class}, tree="[0]")
private Output bgpAuthKey;
/**
* @return The authentication key for BGP configuration.
*
*/
public Output bgpAuthKey() {
return this.bgpAuthKey;
}
/**
* The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
*
*/
@Export(name="connectionId", refs={String.class}, tree="[0]")
private Output connectionId;
/**
* @return The ID of the Direct Connect connection (or LAG) on which to create the virtual interface.
*
*/
public Output connectionId() {
return this.connectionId;
}
/**
* The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
*
*/
@Export(name="customerAddress", refs={String.class}, tree="[0]")
private Output customerAddress;
/**
* @return The IPv4 CIDR destination address to which Amazon should send traffic. Required for IPv4 BGP peers.
*
*/
public Output customerAddress() {
return this.customerAddress;
}
/**
* The ID of the Direct Connect gateway to which to connect the virtual interface.
*
*/
@Export(name="dxGatewayId", refs={String.class}, tree="[0]")
private Output dxGatewayId;
/**
* @return The ID of the Direct Connect gateway to which to connect the virtual interface.
*
*/
public Output> dxGatewayId() {
return Codegen.optional(this.dxGatewayId);
}
/**
* Indicates whether jumbo frames (9001 MTU) are supported.
*
*/
@Export(name="jumboFrameCapable", refs={Boolean.class}, tree="[0]")
private Output jumboFrameCapable;
/**
* @return Indicates whether jumbo frames (9001 MTU) are supported.
*
*/
public Output jumboFrameCapable() {
return this.jumboFrameCapable;
}
/**
* The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection.
* The MTU of a virtual private interface can be either `1500` or `9001` (jumbo frames). Default is `1500`.
*
*/
@Export(name="mtu", refs={Integer.class}, tree="[0]")
private Output mtu;
/**
* @return The maximum transmission unit (MTU) is the size, in bytes, of the largest permissible packet that can be passed over the connection.
* The MTU of a virtual private interface can be either `1500` or `9001` (jumbo frames). Default is `1500`.
*
*/
public Output> mtu() {
return Codegen.optional(this.mtu);
}
/**
* The name for the virtual interface.
*
*/
@Export(name="name", refs={String.class}, tree="[0]")
private Output name;
/**
* @return The name for the virtual interface.
*
*/
public Output name() {
return this.name;
}
/**
* Indicates whether to enable or disable SiteLink.
*
*/
@Export(name="sitelinkEnabled", refs={Boolean.class}, tree="[0]")
private Output sitelinkEnabled;
/**
* @return Indicates whether to enable or disable SiteLink.
*
*/
public Output> sitelinkEnabled() {
return Codegen.optional(this.sitelinkEnabled);
}
/**
* 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.
*
*/
@Export(name="tags", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tags;
/**
* @return 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 Output>> tags() {
return Codegen.optional(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Export(name="tagsAll", refs={Map.class,String.class}, tree="[0,1,1]")
private Output> tagsAll;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
*/
public Output> tagsAll() {
return this.tagsAll;
}
/**
* The VLAN ID.
*
*/
@Export(name="vlan", refs={Integer.class}, tree="[0]")
private Output vlan;
/**
* @return The VLAN ID.
*
*/
public Output vlan() {
return this.vlan;
}
/**
* The ID of the virtual private gateway to which to connect the virtual interface.
*
*/
@Export(name="vpnGatewayId", refs={String.class}, tree="[0]")
private Output vpnGatewayId;
/**
* @return The ID of the virtual private gateway to which to connect the virtual interface.
*
*/
public Output> vpnGatewayId() {
return Codegen.optional(this.vpnGatewayId);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public PrivateVirtualInterface(java.lang.String name) {
this(name, PrivateVirtualInterfaceArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public PrivateVirtualInterface(java.lang.String name, PrivateVirtualInterfaceArgs 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 PrivateVirtualInterface(java.lang.String name, PrivateVirtualInterfaceArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:directconnect/privateVirtualInterface:PrivateVirtualInterface", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
}
private PrivateVirtualInterface(java.lang.String name, Output id, @Nullable PrivateVirtualInterfaceState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:directconnect/privateVirtualInterface:PrivateVirtualInterface", name, state, makeResourceOptions(options, id), false);
}
private static PrivateVirtualInterfaceArgs makeArgs(PrivateVirtualInterfaceArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
if (options != null && options.getUrn().isPresent()) {
return null;
}
return args == null ? PrivateVirtualInterfaceArgs.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 PrivateVirtualInterface get(java.lang.String name, Output id, @Nullable PrivateVirtualInterfaceState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new PrivateVirtualInterface(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy