Try AWS Native preview for resources not in the classic version.
aws.networkmanager.ConnectPeer
Explore with Pulumi AI
Try AWS Native preview for resources not in the classic version.
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:
- Connect
Attachment stringId The ID of the connection attachment.
- Inside
Cidr List<string>Blocks The inside IP addresses used for BGP peering.
- Peer
Address string The Connect peer address.
The following arguments are optional:
- Bgp
Options ConnectPeer Bgp Options The Connect peer BGP options.
- Core
Network stringAddress A Connect peer core network address.
- 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.
- Connect
Attachment stringId The ID of the connection attachment.
- Inside
Cidr []stringBlocks The inside IP addresses used for BGP peering.
- Peer
Address string The Connect peer address.
The following arguments are optional:
- Bgp
Options ConnectPeer Bgp Options Args The Connect peer BGP options.
- Core
Network stringAddress A Connect peer core network address.
- 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.
- connect
Attachment StringId The ID of the connection attachment.
- inside
Cidr List<String>Blocks The inside IP addresses used for BGP peering.
- peer
Address String The Connect peer address.
The following arguments are optional:
- bgp
Options ConnectPeer Bgp Options The Connect peer BGP options.
- core
Network StringAddress A Connect peer core network address.
- 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.
- connect
Attachment stringId The ID of the connection attachment.
- inside
Cidr string[]Blocks The inside IP addresses used for BGP peering.
- peer
Address string The Connect peer address.
The following arguments are optional:
- bgp
Options ConnectPeer Bgp Options The Connect peer BGP options.
- core
Network stringAddress A Connect peer core network address.
- {[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_ strid The ID of the connection attachment.
- inside_
cidr_ Sequence[str]blocks The inside IP addresses used for BGP peering.
- peer_
address str The Connect peer address.
The following arguments are optional:
- bgp_
options ConnectPeer Bgp Options Args The Connect peer BGP options.
- core_
network_ straddress A Connect peer core network address.
- 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.
- connect
Attachment StringId The ID of the connection attachment.
- inside
Cidr List<String>Blocks The inside IP addresses used for BGP peering.
- peer
Address String The Connect peer address.
The following arguments are optional:
- bgp
Options Property Map The Connect peer BGP options.
- core
Network StringAddress A Connect peer core network address.
- 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<Connect
Peer Configuration> The configuration of the Connect peer.
- Connect
Peer stringId - Core
Network stringId The ID of a core network.
- Created
At string - Edge
Location 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.
- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- Arn string
The ARN of the attachment.
- Configurations
[]Connect
Peer Configuration The configuration of the Connect peer.
- Connect
Peer stringId - Core
Network stringId The ID of a core network.
- Created
At string - Edge
Location 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.
- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
The ARN of the attachment.
- configurations
List<Connect
Peer Configuration> The configuration of the Connect peer.
- connect
Peer StringId - core
Network StringId The ID of a core network.
- created
At String - edge
Location 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.
- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn string
The ARN of the attachment.
- configurations
Connect
Peer Configuration[] The configuration of the Connect peer.
- connect
Peer stringId - core
Network stringId The ID of a core network.
- created
At string - edge
Location 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.
- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn str
The ARN of the attachment.
- configurations
Sequence[Connect
Peer Configuration] The configuration of the Connect peer.
- connect_
peer_ strid - core_
network_ strid 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.
- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
The ARN of the attachment.
- configurations List<Property Map>
The configuration of the Connect peer.
- connect
Peer StringId - core
Network StringId The ID of a core network.
- created
At String - edge
Location 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.
- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
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.
- Arn string
The ARN of the attachment.
- Bgp
Options ConnectPeer Bgp Options The Connect peer BGP options.
- Configurations
List<Connect
Peer Configuration> The configuration of the Connect peer.
- Connect
Attachment stringId The ID of the connection attachment.
- Connect
Peer stringId - Core
Network stringAddress A Connect peer core network address.
- Core
Network stringId The ID of a core network.
- Created
At string - Edge
Location string The Region where the peer is located.
- Inside
Cidr List<string>Blocks The inside IP addresses used for BGP peering.
- Peer
Address string The Connect peer address.
The following arguments are optional:
- State string
The state of the Connect peer.
- 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.- Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- Arn string
The ARN of the attachment.
- Bgp
Options ConnectPeer Bgp Options Args The Connect peer BGP options.
- Configurations
[]Connect
Peer Configuration Args The configuration of the Connect peer.
- Connect
Attachment stringId The ID of the connection attachment.
- Connect
Peer stringId - Core
Network stringAddress A Connect peer core network address.
- Core
Network stringId The ID of a core network.
- Created
At string - Edge
Location string The Region where the peer is located.
- Inside
Cidr []stringBlocks The inside IP addresses used for BGP peering.
- Peer
Address string The Connect peer address.
The following arguments are optional:
- State string
The state of the Connect peer.
- 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.- map[string]string
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
The ARN of the attachment.
- bgp
Options ConnectPeer Bgp Options The Connect peer BGP options.
- configurations
List<Connect
Peer Configuration> The configuration of the Connect peer.
- connect
Attachment StringId The ID of the connection attachment.
- connect
Peer StringId - core
Network StringAddress A Connect peer core network address.
- core
Network StringId The ID of a core network.
- created
At String - edge
Location String The Region where the peer is located.
- inside
Cidr List<String>Blocks The inside IP addresses used for BGP peering.
- peer
Address String The Connect peer address.
The following arguments are optional:
- state String
The state of the Connect peer.
- 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.- Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn string
The ARN of the attachment.
- bgp
Options ConnectPeer Bgp Options The Connect peer BGP options.
- configurations
Connect
Peer Configuration[] The configuration of the Connect peer.
- connect
Attachment stringId The ID of the connection attachment.
- connect
Peer stringId - core
Network stringAddress A Connect peer core network address.
- core
Network stringId The ID of a core network.
- created
At string - edge
Location string The Region where the peer is located.
- inside
Cidr string[]Blocks The inside IP addresses used for BGP peering.
- peer
Address string The Connect peer address.
The following arguments are optional:
- state string
The state of the Connect peer.
- {[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.- {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn str
The ARN of the attachment.
- bgp_
options ConnectPeer Bgp Options Args The Connect peer BGP options.
- configurations
Sequence[Connect
Peer Configuration Args] The configuration of the Connect peer.
- connect_
attachment_ strid The ID of the connection attachment.
- connect_
peer_ strid - core_
network_ straddress A Connect peer core network address.
- core_
network_ strid The ID of a core network.
- created_
at str - edge_
location str The Region where the peer is located.
- inside_
cidr_ Sequence[str]blocks The inside IP addresses used for BGP peering.
- peer_
address str The Connect peer address.
The following arguments are optional:
- state str
The state of the Connect peer.
- 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.- Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
- arn String
The ARN of the attachment.
- bgp
Options Property Map The Connect peer BGP options.
- configurations List<Property Map>
The configuration of the Connect peer.
- connect
Attachment StringId The ID of the connection attachment.
- connect
Peer StringId - core
Network StringAddress A Connect peer core network address.
- core
Network StringId The ID of a core network.
- created
At String - edge
Location String The Region where the peer is located.
- inside
Cidr List<String>Blocks The inside IP addresses used for BGP peering.
- peer
Address String The Connect peer address.
The following arguments are optional:
- state String
The state of the Connect peer.
- 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.- Map<String>
A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block.Please use
tags
instead.
Supporting Types
ConnectPeerBgpOptions, ConnectPeerBgpOptionsArgs
- Peer
Asn int
- Peer
Asn int
- peer
Asn Integer
- peer
Asn number
- peer_
asn int
- peer
Asn Number
ConnectPeerConfiguration, ConnectPeerConfigurationArgs
- Bgp
Configurations List<ConnectPeer Configuration Bgp Configuration> - Core
Network stringAddress A Connect peer core network address.
- Inside
Cidr List<string>Blocks The inside IP addresses used for BGP peering.
- Peer
Address string The Connect peer address.
The following arguments are optional:
- Protocol string
- Bgp
Configurations []ConnectPeer Configuration Bgp Configuration - Core
Network stringAddress A Connect peer core network address.
- Inside
Cidr []stringBlocks The inside IP addresses used for BGP peering.
- Peer
Address string The Connect peer address.
The following arguments are optional:
- Protocol string
- bgp
Configurations List<ConnectPeer Configuration Bgp Configuration> - core
Network StringAddress A Connect peer core network address.
- inside
Cidr List<String>Blocks The inside IP addresses used for BGP peering.
- peer
Address String The Connect peer address.
The following arguments are optional:
- protocol String
- bgp
Configurations ConnectPeer Configuration Bgp Configuration[] - core
Network stringAddress A Connect peer core network address.
- inside
Cidr string[]Blocks The inside IP addresses used for BGP peering.
- peer
Address string The Connect peer address.
The following arguments are optional:
- protocol string
- bgp_
configurations Sequence[ConnectPeer Configuration Bgp Configuration] - core_
network_ straddress A Connect peer core network address.
- inside_
cidr_ Sequence[str]blocks The inside IP addresses used for BGP peering.
- peer_
address str The Connect peer address.
The following arguments are optional:
- protocol str
- bgp
Configurations List<Property Map> - core
Network StringAddress A Connect peer core network address.
- inside
Cidr List<String>Blocks The inside IP addresses used for BGP peering.
- peer
Address String The Connect peer address.
The following arguments are optional:
- protocol String
ConnectPeerConfigurationBgpConfiguration, ConnectPeerConfigurationBgpConfigurationArgs
- Core
Network stringAddress A Connect peer core network address.
- Core
Network intAsn - Peer
Address string The Connect peer address.
The following arguments are optional:
- Peer
Asn int
- Core
Network stringAddress A Connect peer core network address.
- Core
Network intAsn - Peer
Address string The Connect peer address.
The following arguments are optional:
- Peer
Asn int
- core
Network StringAddress A Connect peer core network address.
- core
Network IntegerAsn - peer
Address String The Connect peer address.
The following arguments are optional:
- peer
Asn Integer
- core
Network stringAddress A Connect peer core network address.
- core
Network numberAsn - peer
Address string The Connect peer address.
The following arguments are optional:
- peer
Asn number
- core_
network_ straddress A Connect peer core network address.
- core_
network_ intasn - peer_
address str The Connect peer address.
The following arguments are optional:
- peer_
asn int
- core
Network StringAddress A Connect peer core network address.
- core
Network NumberAsn - peer
Address String The Connect peer address.
The following arguments are optional:
- peer
Asn Number
Import
Using pulumi import
, import aws_networkmanager_connect_peer
using the connect peer ID. For example:
$ 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.
Try AWS Native preview for resources not in the classic version.