com.pulumi.aws.directconnect.BgpPeer 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.66.3
// *** 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.BgpPeerArgs;
import com.pulumi.aws.directconnect.inputs.BgpPeerState;
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.Integer;
import java.lang.String;
import javax.annotation.Nullable;

/**
 * Provides a Direct Connect BGP peer 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.BgpPeer;
 * import com.pulumi.aws.directconnect.BgpPeerArgs;
 * 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 peer = new BgpPeer("peer", BgpPeerArgs.builder()
 *             .virtualInterfaceId(foo.id())
 *             .addressFamily("ipv6")
 *             .bgpAsn(65351)
 *             .build());
 * 
 *     }
 * }
 * }
 * 
 * <!--End PulumiCodeChooser -->
 * 
 */
@ResourceType(type="aws:directconnect/bgpPeer:BgpPeer")
public class BgpPeer 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 on public virtual interfaces.
     * 
     */
    @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 on public virtual interfaces.
     * 
     */
    public Output amazonAddress() {
        return this.amazonAddress;
    }
    /**
     * The Direct Connect endpoint on which the BGP peer terminates.
     * 
     */
    @Export(name="awsDevice", refs={String.class}, tree="[0]")
    private Output awsDevice;

    /**
     * @return The Direct Connect endpoint on which the BGP peer 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 BGP peer.
     * 
     */
    @Export(name="bgpPeerId", refs={String.class}, tree="[0]")
    private Output bgpPeerId;

    /**
     * @return The ID of the BGP peer.
     * 
     */
    public Output bgpPeerId() {
        return this.bgpPeerId;
    }
    /**
     * The Up/Down state of the BGP peer.
     * 
     */
    @Export(name="bgpStatus", refs={String.class}, tree="[0]")
    private Output bgpStatus;

    /**
     * @return The Up/Down state of the BGP peer.
     * 
     */
    public Output bgpStatus() {
        return this.bgpStatus;
    }
    /**
     * The IPv4 CIDR destination address to which Amazon should send traffic.
     * Required for IPv4 BGP peers on public virtual interfaces.
     * 
     */
    @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 on public virtual interfaces.
     * 
     */
    public Output customerAddress() {
        return this.customerAddress;
    }
    /**
     * The ID of the Direct Connect virtual interface on which to create the BGP peer.
     * 
     */
    @Export(name="virtualInterfaceId", refs={String.class}, tree="[0]")
    private Output virtualInterfaceId;

    /**
     * @return The ID of the Direct Connect virtual interface on which to create the BGP peer.
     * 
     */
    public Output virtualInterfaceId() {
        return this.virtualInterfaceId;
    }

    /**
     *
     * @param name The _unique_ name of the resulting resource.
     */
    public BgpPeer(java.lang.String name) {
        this(name, BgpPeerArgs.Empty);
    }
    /**
     *
     * @param name The _unique_ name of the resulting resource.
     * @param args The arguments to use to populate this resource's properties.
     */
    public BgpPeer(java.lang.String name, BgpPeerArgs 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 BgpPeer(java.lang.String name, BgpPeerArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:directconnect/bgpPeer:BgpPeer", name, makeArgs(args, options), makeResourceOptions(options, Codegen.empty()), false);
    }

    private BgpPeer(java.lang.String name, Output id, @Nullable BgpPeerState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        super("aws:directconnect/bgpPeer:BgpPeer", name, state, makeResourceOptions(options, id), false);
    }

    private static BgpPeerArgs makeArgs(BgpPeerArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        if (options != null && options.getUrn().isPresent()) {
            return null;
        }
        return args == null ? BgpPeerArgs.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 BgpPeer get(java.lang.String name, Output id, @Nullable BgpPeerState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
        return new BgpPeer(name, id, state, options);
    }
}