NetworkPeeringRoutesConfig
Manage a network peering’s route settings without managing the peering as a whole. This resource is primarily intended for use with GCP-generated peerings that shouldn’t otherwise be managed by other tools. Deleting this resource is a no-op and the peering will not be modified.
To get more information about NetworkPeeringRoutesConfig, see:
- API documentation
- How-to Guides
Create a NetworkPeeringRoutesConfig Resource
new NetworkPeeringRoutesConfig(name: string, args: NetworkPeeringRoutesConfigArgs, opts?: CustomResourceOptions);def NetworkPeeringRoutesConfig(resource_name, opts=None, export_custom_routes=None, import_custom_routes=None, network=None, peering=None, project=None, __props__=None);func NewNetworkPeeringRoutesConfig(ctx *Context, name string, args NetworkPeeringRoutesConfigArgs, opts ...ResourceOption) (*NetworkPeeringRoutesConfig, error)public NetworkPeeringRoutesConfig(string name, NetworkPeeringRoutesConfigArgs args, CustomResourceOptions? opts = null)- name string
- The unique name of the resource.
- args NetworkPeeringRoutesConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- opts ResourceOptions
- A bag of options that control this resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NetworkPeeringRoutesConfigArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NetworkPeeringRoutesConfigArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
NetworkPeeringRoutesConfig Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The NetworkPeeringRoutesConfig resource accepts the following input properties:
- Export
Custom boolRoutes Whether to export the custom routes to the peer network.
- Import
Custom boolRoutes Whether to import the custom routes to the peer network.
- Network string
The name of the primary network for the peering.
- Peering string
Name of the peering.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Export
Custom boolRoutes Whether to export the custom routes to the peer network.
- Import
Custom boolRoutes Whether to import the custom routes to the peer network.
- Network string
The name of the primary network for the peering.
- Peering string
Name of the peering.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- export
Custom booleanRoutes Whether to export the custom routes to the peer network.
- import
Custom booleanRoutes Whether to import the custom routes to the peer network.
- network string
The name of the primary network for the peering.
- peering string
Name of the peering.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- export_
custom_ boolroutes Whether to export the custom routes to the peer network.
- import_
custom_ boolroutes Whether to import the custom routes to the peer network.
- network str
The name of the primary network for the peering.
- peering str
Name of the peering.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Outputs
All input properties are implicitly available as output properties. Additionally, the NetworkPeeringRoutesConfig resource produces the following output properties:
Look up an Existing NetworkPeeringRoutesConfig Resource
Get an existing NetworkPeeringRoutesConfig 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?: NetworkPeeringRoutesConfigState, opts?: CustomResourceOptions): NetworkPeeringRoutesConfigstatic get(resource_name, id, opts=None, export_custom_routes=None, import_custom_routes=None, network=None, peering=None, project=None, __props__=None);func GetNetworkPeeringRoutesConfig(ctx *Context, name string, id IDInput, state *NetworkPeeringRoutesConfigState, opts ...ResourceOption) (*NetworkPeeringRoutesConfig, error)public static NetworkPeeringRoutesConfig Get(string name, Input<string> id, NetworkPeeringRoutesConfigState? state, CustomResourceOptions? opts = null)- 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.
The following state arguments are supported:
- Export
Custom boolRoutes Whether to export the custom routes to the peer network.
- Import
Custom boolRoutes Whether to import the custom routes to the peer network.
- Network string
The name of the primary network for the peering.
- Peering string
Name of the peering.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- Export
Custom boolRoutes Whether to export the custom routes to the peer network.
- Import
Custom boolRoutes Whether to import the custom routes to the peer network.
- Network string
The name of the primary network for the peering.
- Peering string
Name of the peering.
- Project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- export
Custom booleanRoutes Whether to export the custom routes to the peer network.
- import
Custom booleanRoutes Whether to import the custom routes to the peer network.
- network string
The name of the primary network for the peering.
- peering string
Name of the peering.
- project string
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
- export_
custom_ boolroutes Whether to export the custom routes to the peer network.
- import_
custom_ boolroutes Whether to import the custom routes to the peer network.
- network str
The name of the primary network for the peering.
- peering str
Name of the peering.
- project str
The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
Package Details
- Repository
- https://github.com/pulumi/pulumi-gcp
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
google-betaTerraform Provider.