AWS Classic v5.34.0, Mar 30 23

aws.networkmanager.ConnectPeer

Resource for managing an AWS NetworkManager Connect Peer.

Create ConnectPeer Resource

new ConnectPeer(name: string, args: ConnectPeerArgs, opts?: CustomResourceOptions);

@overload
def ConnectPeer(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                bgp_options: Optional[ConnectPeerBgpOptionsArgs] = None,
                connect_attachment_id: Optional[str] = None,
                core_network_address: Optional[str] = None,
                inside_cidr_blocks: Optional[Sequence[str]] = None,
                peer_address: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None)
@overload
def ConnectPeer(resource_name: str,
                args: ConnectPeerArgs,
                opts: Optional[ResourceOptions] = None)

func NewConnectPeer(ctx *Context, name string, args ConnectPeerArgs, opts ...ResourceOption) (*ConnectPeer, error)

public ConnectPeer(string name, ConnectPeerArgs args, CustomResourceOptions? opts = null)

public ConnectPeer(String name, ConnectPeerArgs args)
public ConnectPeer(String name, ConnectPeerArgs args, CustomResourceOptions options)

type: aws:networkmanager:ConnectPeer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectPeerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args ConnectPeerArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ConnectPeerArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ConnectPeerArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ConnectPeerArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ConnectPeer Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The ConnectPeer resource accepts the following input properties:

ConnectAttachmentId string: The ID of the connection attachment.
InsideCidrBlocks List<string>: The inside IP addresses used for BGP peering.
PeerAddress string: The Connect peer address.
BgpOptions ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
CoreNetworkAddress string: A Connect peer core network address.
Tags Dictionary<string, string>: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

ConnectAttachmentId string: The ID of the connection attachment.
InsideCidrBlocks []string: The inside IP addresses used for BGP peering.
PeerAddress string: The Connect peer address.
BgpOptions ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
CoreNetworkAddress string: A Connect peer core network address.
Tags map[string]string: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

connectAttachmentId String: The ID of the connection attachment.
insideCidrBlocks List<String>: The inside IP addresses used for BGP peering.
peerAddress String: The Connect peer address.
bgpOptions ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
coreNetworkAddress String: A Connect peer core network address.
tags Map<String,String>: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

connectAttachmentId string: The ID of the connection attachment.
insideCidrBlocks string[]: The inside IP addresses used for BGP peering.
peerAddress string: The Connect peer address.
bgpOptions ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
coreNetworkAddress string: A Connect peer core network address.
tags {[key: string]: string}: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

connect_attachment_id str: The ID of the connection attachment.
inside_cidr_blocks Sequence[str]: The inside IP addresses used for BGP peering.
peer_address str: The Connect peer address.
bgp_options ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
core_network_address str: A Connect peer core network address.
tags Mapping[str, str]: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

connectAttachmentId String: The ID of the connection attachment.
insideCidrBlocks List<String>: The inside IP addresses used for BGP peering.
peerAddress String: The Connect peer address.
bgpOptions Property Map: The Connect peer BGP options.
coreNetworkAddress String: A Connect peer core network address.
tags Map<String>: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

Outputs

All input properties are implicitly available as output properties. Additionally, the ConnectPeer resource produces the following output properties:

Arn string: The ARN of the attachment.
Configurations List<ConnectPeerConfiguration>: The configuration of the Connect peer.
ConnectPeerId string
CoreNetworkId string: The ID of a core network.
CreatedAt string
EdgeLocation string: The Region where the peer is located.
Id string: The provider-assigned unique ID for this managed resource.
State string: The state of the Connect peer.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: The ARN of the attachment.
Configurations []ConnectPeerConfiguration: The configuration of the Connect peer.
ConnectPeerId string
CoreNetworkId string: The ID of a core network.
CreatedAt string
EdgeLocation string: The Region where the peer is located.
Id string: The provider-assigned unique ID for this managed resource.
State string: The state of the Connect peer.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The ARN of the attachment.
configurations List<ConnectPeerConfiguration>: The configuration of the Connect peer.
connectPeerId String
coreNetworkId String: The ID of a core network.
createdAt String
edgeLocation String: The Region where the peer is located.
id String: The provider-assigned unique ID for this managed resource.
state String: The state of the Connect peer.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: The ARN of the attachment.
configurations ConnectPeerConfiguration[]: The configuration of the Connect peer.
connectPeerId string
coreNetworkId string: The ID of a core network.
createdAt string
edgeLocation string: The Region where the peer is located.
id string: The provider-assigned unique ID for this managed resource.
state string: The state of the Connect peer.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: The ARN of the attachment.
configurations Sequence[ConnectPeerConfiguration]: The configuration of the Connect peer.
connect_peer_id str
core_network_id str: The ID of a core network.
created_at str
edge_location str: The Region where the peer is located.
id str: The provider-assigned unique ID for this managed resource.
state str: The state of the Connect peer.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The ARN of the attachment.
configurations List<Property Map>: The configuration of the Connect peer.
connectPeerId String
coreNetworkId String: The ID of a core network.
createdAt String
edgeLocation String: The Region where the peer is located.
id String: The provider-assigned unique ID for this managed resource.
state String: The state of the Connect peer.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Look up Existing ConnectPeer Resource

Get an existing ConnectPeer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ConnectPeerState, opts?: CustomResourceOptions): ConnectPeer

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        bgp_options: Optional[ConnectPeerBgpOptionsArgs] = None,
        configurations: Optional[Sequence[ConnectPeerConfigurationArgs]] = None,
        connect_attachment_id: Optional[str] = None,
        connect_peer_id: Optional[str] = None,
        core_network_address: Optional[str] = None,
        core_network_id: Optional[str] = None,
        created_at: Optional[str] = None,
        edge_location: Optional[str] = None,
        inside_cidr_blocks: Optional[Sequence[str]] = None,
        peer_address: Optional[str] = None,
        state: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ConnectPeer

func GetConnectPeer(ctx *Context, name string, id IDInput, state *ConnectPeerState, opts ...ResourceOption) (*ConnectPeer, error)

public static ConnectPeer Get(string name, Input<string> id, ConnectPeerState? state, CustomResourceOptions? opts = null)

public static ConnectPeer get(String name, Output<String> id, ConnectPeerState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The ARN of the attachment.
BgpOptions ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
Configurations List<ConnectPeerConfigurationArgs>: The configuration of the Connect peer.
ConnectAttachmentId string: The ID of the connection attachment.
ConnectPeerId string
CoreNetworkAddress string: A Connect peer core network address.
CoreNetworkId string: The ID of a core network.
CreatedAt string
EdgeLocation string: The Region where the peer is located.
InsideCidrBlocks List<string>: The inside IP addresses used for BGP peering.
PeerAddress string: The Connect peer address.
State string: The state of the Connect peer.
Tags Dictionary<string, string>: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll Dictionary<string, string>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Arn string: The ARN of the attachment.
BgpOptions ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
Configurations []ConnectPeerConfigurationArgs: The configuration of the Connect peer.
ConnectAttachmentId string: The ID of the connection attachment.
ConnectPeerId string
CoreNetworkAddress string: A Connect peer core network address.
CoreNetworkId string: The ID of a core network.
CreatedAt string
EdgeLocation string: The Region where the peer is located.
InsideCidrBlocks []string: The inside IP addresses used for BGP peering.
PeerAddress string: The Connect peer address.
State string: The state of the Connect peer.
Tags map[string]string: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
TagsAll map[string]string: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The ARN of the attachment.
bgpOptions ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
configurations List<ConnectPeerConfigurationArgs>: The configuration of the Connect peer.
connectAttachmentId String: The ID of the connection attachment.
connectPeerId String
coreNetworkAddress String: A Connect peer core network address.
coreNetworkId String: The ID of a core network.
createdAt String
edgeLocation String: The Region where the peer is located.
insideCidrBlocks List<String>: The inside IP addresses used for BGP peering.
peerAddress String: The Connect peer address.
state String: The state of the Connect peer.
tags Map<String,String>: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String,String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn string: The ARN of the attachment.
bgpOptions ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
configurations ConnectPeerConfigurationArgs[]: The configuration of the Connect peer.
connectAttachmentId string: The ID of the connection attachment.
connectPeerId string
coreNetworkAddress string: A Connect peer core network address.
coreNetworkId string: The ID of a core network.
createdAt string
edgeLocation string: The Region where the peer is located.
insideCidrBlocks string[]: The inside IP addresses used for BGP peering.
peerAddress string: The Connect peer address.
state string: The state of the Connect peer.
tags {[key: string]: string}: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll {[key: string]: string}: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn str: The ARN of the attachment.
bgp_options ConnectPeerBgpOptionsArgs: The Connect peer BGP options.
configurations Sequence[ConnectPeerConfigurationArgs]: The configuration of the Connect peer.
connect_attachment_id str: The ID of the connection attachment.
connect_peer_id str
core_network_address str: A Connect peer core network address.
core_network_id str: The ID of a core network.
created_at str
edge_location str: The Region where the peer is located.
inside_cidr_blocks Sequence[str]: The inside IP addresses used for BGP peering.
peer_address str: The Connect peer address.
state str: The state of the Connect peer.
tags Mapping[str, str]: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tags_all Mapping[str, str]: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

arn String: The ARN of the attachment.
bgpOptions Property Map: The Connect peer BGP options.
configurations List<Property Map>: The configuration of the Connect peer.
connectAttachmentId String: The ID of the connection attachment.
connectPeerId String
coreNetworkAddress String: A Connect peer core network address.
coreNetworkId String: The ID of a core network.
createdAt String
edgeLocation String: The Region where the peer is located.
insideCidrBlocks List<String>: The inside IP addresses used for BGP peering.
peerAddress String: The Connect peer address.
state String: The state of the Connect peer.
tags Map<String>: Key-value tags for the attachment. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
tagsAll Map<String>: A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Supporting Types

ConnectPeerBgpOptions

PeerAsn int

PeerAsn int

peerAsn Integer

peerAsn number

peer_asn int

peerAsn Number

ConnectPeerConfiguration

BgpConfigurations List<ConnectPeerConfigurationBgpConfiguration>
CoreNetworkAddress string: A Connect peer core network address.
InsideCidrBlocks List<string>: The inside IP addresses used for BGP peering.
PeerAddress string: The Connect peer address.
Protocol string

BgpConfigurations []ConnectPeerConfigurationBgpConfiguration
CoreNetworkAddress string: A Connect peer core network address.
InsideCidrBlocks []string: The inside IP addresses used for BGP peering.
PeerAddress string: The Connect peer address.
Protocol string

bgpConfigurations List<ConnectPeerConfigurationBgpConfiguration>
coreNetworkAddress String: A Connect peer core network address.
insideCidrBlocks List<String>: The inside IP addresses used for BGP peering.
peerAddress String: The Connect peer address.
protocol String

bgpConfigurations ConnectPeerConfigurationBgpConfiguration[]
coreNetworkAddress string: A Connect peer core network address.
insideCidrBlocks string[]: The inside IP addresses used for BGP peering.
peerAddress string: The Connect peer address.
protocol string

bgp_configurations Sequence[ConnectPeerConfigurationBgpConfiguration]
core_network_address str: A Connect peer core network address.
inside_cidr_blocks Sequence[str]: The inside IP addresses used for BGP peering.
peer_address str: The Connect peer address.
protocol str

bgpConfigurations List<Property Map>
coreNetworkAddress String: A Connect peer core network address.
insideCidrBlocks List<String>: The inside IP addresses used for BGP peering.
peerAddress String: The Connect peer address.
protocol String

ConnectPeerConfigurationBgpConfiguration

CoreNetworkAddress string: A Connect peer core network address.
CoreNetworkAsn int
PeerAddress string: The Connect peer address.
PeerAsn int

CoreNetworkAddress string: A Connect peer core network address.
CoreNetworkAsn int
PeerAddress string: The Connect peer address.
PeerAsn int

coreNetworkAddress String: A Connect peer core network address.
coreNetworkAsn Integer
peerAddress String: The Connect peer address.
peerAsn Integer

coreNetworkAddress string: A Connect peer core network address.
coreNetworkAsn number
peerAddress string: The Connect peer address.
peerAsn number

core_network_address str: A Connect peer core network address.
core_network_asn int
peer_address str: The Connect peer address.
peer_asn int

coreNetworkAddress String: A Connect peer core network address.
coreNetworkAsn Number
peerAddress String: The Connect peer address.
peerAsn Number

Import

aws_networkmanager_connect_peer can be imported using the connect peer ID, e.g.

 $ pulumi import aws:networkmanager/connectPeer:ConnectPeer example connect-peer-061f3e96275db1acc

Package Details

Repository: AWS Classic pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.