Package com.hashicorp.cdktf.providers.google.compute_router_peer

Interface ComputeRouterPeerConfig

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments
    All Known Implementing Classes:
    ComputeRouterPeerConfig.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-31T03:59:18.945Z")
@Stability(Stable)
public interface ComputeRouterPeerConfig
extends software.amazon.jsii.JsiiSerializable, com.hashicorp.cdktf.TerraformMetaArguments

    • Method Detail

      • getInterfaceValue

        @Stability(Stable)
@NotNull
String getInterfaceValue()
        Name of the interface the BGP peer is associated with.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#interface ComputeRouterPeer#interface}

      • getName

        @Stability(Stable)
@NotNull
String getName()
        Name of this BGP peer.

        The name must be 1-63 characters long, and comply with RFC1035. Specifically, the name must be 1-63 characters long and match the regular expression '[a-z](%5B-a-z0-9%5D*%5Ba-z0-9%5D)?' which means the first character must be a lowercase letter, and all following characters must be a dash, lowercase letter, or digit, except the last character, which cannot be a dash. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#name ComputeRouterPeer#name}

      • getPeerAsn

        @Stability(Stable)
@NotNull
Number getPeerAsn()
        Peer BGP Autonomous System Number (ASN). Each BGP interface may use a different value.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#peer_asn ComputeRouterPeer#peer_asn}

      • getRouter

        @Stability(Stable)
@NotNull
String getRouter()
        The name of the Cloud Router in which this BgpPeer will be configured.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#router ComputeRouterPeer#router}

      • getAdvertisedGroups

        @Stability(Stable)
@Nullable
default List<String> getAdvertisedGroups()
        User-specified list of prefix groups to advertise in custom mode, which currently supports the following option:.

        * 'ALL_SUBNETS': Advertises all of the router's own VPC subnets. This excludes any routes learned for subnets that use VPC Network Peering. Note that this field can only be populated if advertiseMode is 'CUSTOM' and overrides the list defined for the router (in the "bgp" message). These groups are advertised in addition to any specified prefixes. Leave this field blank to advertise no custom groups. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#advertised_groups ComputeRouterPeer#advertised_groups}

      • getAdvertisedIpRanges

        @Stability(Stable)
@Nullable
default Object getAdvertisedIpRanges()
        advertised_ip_ranges block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#advertised_ip_ranges ComputeRouterPeer#advertised_ip_ranges}

      • getAdvertisedRoutePriority

        @Stability(Stable)
@Nullable
default Number getAdvertisedRoutePriority()
        The priority of routes advertised to this BGP peer.

        Where there is more than one matching route of maximum length, the routes with the lowest priority value win. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#advertised_route_priority ComputeRouterPeer#advertised_route_priority}

      • getAdvertiseMode

        @Stability(Stable)
@Nullable
default String getAdvertiseMode()
        User-specified flag to indicate which mode to use for advertisement.

        Valid values of this enum field are: 'DEFAULT', 'CUSTOM' Default value: "DEFAULT" Possible values: ["DEFAULT", "CUSTOM"] Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#advertise_mode ComputeRouterPeer#advertise_mode}

      • getBfd

        @Stability(Stable)
@Nullable
default ComputeRouterPeerBfd getBfd()
        bfd block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#bfd ComputeRouterPeer#bfd}

      • getCustomLearnedIpRanges

        @Stability(Stable)
@Nullable
default Object getCustomLearnedIpRanges()
        custom_learned_ip_ranges block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#custom_learned_ip_ranges ComputeRouterPeer#custom_learned_ip_ranges}

      • getCustomLearnedRoutePriority

        @Stability(Stable)
@Nullable
default Number getCustomLearnedRoutePriority()
        The user-defined custom learned route priority for a BGP session.

        This value is applied to all custom learned route ranges for the session. You can choose a value from 0 to 65335. If you don't provide a value, Google Cloud assigns a priority of 100 to the ranges. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#custom_learned_route_priority ComputeRouterPeer#custom_learned_route_priority}

      • getEnable

        @Stability(Stable)
@Nullable
default Object getEnable()
        The status of the BGP peer connection.

        If set to false, any active session with the peer is terminated and all associated routing information is removed. If set to true, the peer connection can be established with routing information. The default is true. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#enable ComputeRouterPeer#enable}

      • getEnableIpv4

        @Stability(Stable)
@Nullable
default Object getEnableIpv4()
        Enable IPv4 traffic over BGP Peer. It is enabled by default if the peerIpAddress is version 4.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#enable_ipv4 ComputeRouterPeer#enable_ipv4}

      • getEnableIpv6

        @Stability(Stable)
@Nullable
default Object getEnableIpv6()
        Enable IPv6 traffic over BGP Peer. If not specified, it is disabled by default.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#enable_ipv6 ComputeRouterPeer#enable_ipv6}

      • getId

        @Stability(Stable)
@Nullable
default String getId()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#id ComputeRouterPeer#id}.

        Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2. If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.

      • getIpAddress

        @Stability(Stable)
@Nullable
default String getIpAddress()
        IP address of the interface inside Google Cloud Platform. Only IPv4 is supported.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#ip_address ComputeRouterPeer#ip_address}

      • getIpv4NexthopAddress

        @Stability(Stable)
@Nullable
default String getIpv4NexthopAddress()
        IPv4 address of the interface inside Google Cloud Platform.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#ipv4_nexthop_address ComputeRouterPeer#ipv4_nexthop_address}

      • getIpv6NexthopAddress

        @Stability(Stable)
@Nullable
default String getIpv6NexthopAddress()
        IPv6 address of the interface inside Google Cloud Platform.

        The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#ipv6_nexthop_address ComputeRouterPeer#ipv6_nexthop_address}

      • getMd5AuthenticationKey

        @Stability(Stable)
@Nullable
default ComputeRouterPeerMd5AuthenticationKey getMd5AuthenticationKey()
        md5_authentication_key block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#md5_authentication_key ComputeRouterPeer#md5_authentication_key}

      • getPeerIpAddress

        @Stability(Stable)
@Nullable
default String getPeerIpAddress()
        IP address of the BGP interface outside Google Cloud Platform. Only IPv4 is supported. Required if 'ip_address' is set.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#peer_ip_address ComputeRouterPeer#peer_ip_address}

      • getPeerIpv4NexthopAddress

        @Stability(Stable)
@Nullable
default String getPeerIpv4NexthopAddress()
        IPv4 address of the BGP interface outside Google Cloud Platform.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#peer_ipv4_nexthop_address ComputeRouterPeer#peer_ipv4_nexthop_address}

      • getPeerIpv6NexthopAddress

        @Stability(Stable)
@Nullable
default String getPeerIpv6NexthopAddress()
        IPv6 address of the BGP interface outside Google Cloud Platform.

        The address must be in the range 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64. If you do not specify the next hop addresses, Google Cloud automatically assigns unused addresses from the 2600:2d00:0:2::/64 or 2600:2d00:0:3::/64 range for you. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#peer_ipv6_nexthop_address ComputeRouterPeer#peer_ipv6_nexthop_address}

      • getProject

        @Stability(Stable)
@Nullable
default String getProject()
        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#project ComputeRouterPeer#project}.

      • getRegion

        @Stability(Stable)
@Nullable
default String getRegion()
        Region where the router and BgpPeer reside. If it is not provided, the provider region is used.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#region ComputeRouterPeer#region}

      • getRouterApplianceInstance

        @Stability(Stable)
@Nullable
default String getRouterApplianceInstance()
        The URI of the VM instance that is used as third-party router appliances such as Next Gen Firewalls, Virtual Routers, or Router Appliances.

        The VM instance must be located in zones contained in the same region as this Cloud Router. The VM instance is the peer side of the BGP session. Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#router_appliance_instance ComputeRouterPeer#router_appliance_instance}

      • getTimeouts

        @Stability(Stable)
@Nullable
default ComputeRouterPeerTimeouts getTimeouts()
        timeouts block.

        Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/google/5.43.1/docs/resources/compute_router_peer#timeouts ComputeRouterPeer#timeouts}