1. Packages
  2. AWS
  3. API Docs
  4. networkmanager
  5. GlobalNetwork
AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi

aws.networkmanager.GlobalNetwork

Explore with Pulumi AI

Provides a global network resource.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.networkmanager.GlobalNetwork("example", {description: "example"});
Copy
import pulumi
import pulumi_aws as aws

example = aws.networkmanager.GlobalNetwork("example", description="example")
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/networkmanager"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := networkmanager.NewGlobalNetwork(ctx, "example", &networkmanager.GlobalNetworkArgs{
			Description: pulumi.String("example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.NetworkManager.GlobalNetwork("example", new()
    {
        Description = "example",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkmanager.GlobalNetwork;
import com.pulumi.aws.networkmanager.GlobalNetworkArgs;
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 example = new GlobalNetwork("example", GlobalNetworkArgs.builder()
            .description("example")
            .build());

    }
}
Copy
resources:
  example:
    type: aws:networkmanager:GlobalNetwork
    properties:
      description: example
Copy

Create GlobalNetwork Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GlobalNetwork(name: string, args?: GlobalNetworkArgs, opts?: CustomResourceOptions);
@overload
def GlobalNetwork(resource_name: str,
                  args: Optional[GlobalNetworkArgs] = None,
                  opts: Optional[ResourceOptions] = None)

@overload
def GlobalNetwork(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  description: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
func NewGlobalNetwork(ctx *Context, name string, args *GlobalNetworkArgs, opts ...ResourceOption) (*GlobalNetwork, error)
public GlobalNetwork(string name, GlobalNetworkArgs? args = null, CustomResourceOptions? opts = null)
public GlobalNetwork(String name, GlobalNetworkArgs args)
public GlobalNetwork(String name, GlobalNetworkArgs args, CustomResourceOptions options)
type: aws:networkmanager:GlobalNetwork
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args GlobalNetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args GlobalNetworkArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args GlobalNetworkArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args GlobalNetworkArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GlobalNetworkArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var globalNetworkResource = new Aws.NetworkManager.GlobalNetwork("globalNetworkResource", new()
{
    Description = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := networkmanager.NewGlobalNetwork(ctx, "globalNetworkResource", &networkmanager.GlobalNetworkArgs{
	Description: pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var globalNetworkResource = new GlobalNetwork("globalNetworkResource", GlobalNetworkArgs.builder()
    .description("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
global_network_resource = aws.networkmanager.GlobalNetwork("globalNetworkResource",
    description="string",
    tags={
        "string": "string",
    })
Copy
const globalNetworkResource = new aws.networkmanager.GlobalNetwork("globalNetworkResource", {
    description: "string",
    tags: {
        string: "string",
    },
});
Copy
type: aws:networkmanager:GlobalNetwork
properties:
    description: string
    tags:
        string: string
Copy

GlobalNetwork Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GlobalNetwork resource accepts the following input properties:

Description string
Description of the Global Network.
Tags Dictionary<string, string>
Key-value tags for the Global Network. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
Description string
Description of the Global Network.
Tags map[string]string
Key-value tags for the Global Network. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
description String
Description of the Global Network.
tags Map<String,String>
Key-value tags for the Global Network. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
description string
Description of the Global Network.
tags {[key: string]: string}
Key-value tags for the Global Network. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
description str
Description of the Global Network.
tags Mapping[str, str]
Key-value tags for the Global Network. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
description String
Description of the Global Network.
tags Map<String>
Key-value tags for the Global Network. 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 GlobalNetwork resource produces the following output properties:

Arn string
Global Network Amazon Resource Name (ARN)
Id string
The provider-assigned unique ID for this managed resource.
TagsAll Dictionary<string, string>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Arn string
Global Network Amazon Resource Name (ARN)
Id string
The provider-assigned unique ID for this managed resource.
TagsAll map[string]string
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Global Network Amazon Resource Name (ARN)
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String,String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn string
Global Network Amazon Resource Name (ARN)
id string
The provider-assigned unique ID for this managed resource.
tagsAll {[key: string]: string}
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn str
Global Network Amazon Resource Name (ARN)
id str
The provider-assigned unique ID for this managed resource.
tags_all Mapping[str, str]
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

arn String
Global Network Amazon Resource Name (ARN)
id String
The provider-assigned unique ID for this managed resource.
tagsAll Map<String>
A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

Deprecated: Please use tags instead.

Look up Existing GlobalNetwork Resource

Get an existing GlobalNetwork 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?: GlobalNetworkState, opts?: CustomResourceOptions): GlobalNetwork
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> GlobalNetwork
func GetGlobalNetwork(ctx *Context, name string, id IDInput, state *GlobalNetworkState, opts ...ResourceOption) (*GlobalNetwork, error)
public static GlobalNetwork Get(string name, Input<string> id, GlobalNetworkState? state, CustomResourceOptions? opts = null)
public static GlobalNetwork get(String name, Output<String> id, GlobalNetworkState state, CustomResourceOptions options)
resources:  _:    type: aws:networkmanager:GlobalNetwork    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
Global Network Amazon Resource Name (ARN)
Description string
Description of the Global Network.
Tags Dictionary<string, string>
Key-value tags for the Global Network. 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.

Deprecated: Please use tags instead.

Arn string
Global Network Amazon Resource Name (ARN)
Description string
Description of the Global Network.
Tags map[string]string
Key-value tags for the Global Network. 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.

Deprecated: Please use tags instead.

arn String
Global Network Amazon Resource Name (ARN)
description String
Description of the Global Network.
tags Map<String,String>
Key-value tags for the Global Network. 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.

Deprecated: Please use tags instead.

arn string
Global Network Amazon Resource Name (ARN)
description string
Description of the Global Network.
tags {[key: string]: string}
Key-value tags for the Global Network. 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.

Deprecated: Please use tags instead.

arn str
Global Network Amazon Resource Name (ARN)
description str
Description of the Global Network.
tags Mapping[str, str]
Key-value tags for the Global Network. 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.

Deprecated: Please use tags instead.

arn String
Global Network Amazon Resource Name (ARN)
description String
Description of the Global Network.
tags Map<String>
Key-value tags for the Global Network. 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.

Deprecated: Please use tags instead.

Import

Using pulumi import, import aws_networkmanager_global_network using the global network ID. For example:

$ pulumi import aws:networkmanager/globalNetwork:GlobalNetwork example global-network-0d47f6t230mz46dy4
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

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