Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. vpclattice
  5. ServiceNetwork
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.vpclattice.ServiceNetwork

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Resource for managing an AWS VPC Lattice Service Network.

    Example Usage

    Basic Usage

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

const example = new aws.vpclattice.ServiceNetwork("example", {
    name: "example",
    authType: "AWS_IAM",
});

    import pulumi
import pulumi_aws as aws

example = aws.vpclattice.ServiceNetwork("example",
    name="example",
    auth_type="AWS_IAM")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vpclattice.NewServiceNetwork(ctx, "example", &vpclattice.ServiceNetworkArgs{
			Name:     pulumi.String("example"),
			AuthType: pulumi.String("AWS_IAM"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.VpcLattice.ServiceNetwork("example", new()
    {
        Name = "example",
        AuthType = "AWS_IAM",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpclattice.ServiceNetwork;
import com.pulumi.aws.vpclattice.ServiceNetworkArgs;
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 ServiceNetwork("example", ServiceNetworkArgs.builder()
            .name("example")
            .authType("AWS_IAM")
            .build());

    }
}

    resources:
  example:
    type: aws:vpclattice:ServiceNetwork
    properties:
      name: example
      authType: AWS_IAM

    Create ServiceNetwork Resource

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

    Constructor syntax

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

@overload
def ServiceNetwork(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   auth_type: Optional[str] = None,
                   name: Optional[str] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewServiceNetwork(ctx *Context, name string, args *ServiceNetworkArgs, opts ...ResourceOption) (*ServiceNetwork, error)
    public ServiceNetwork(string name, ServiceNetworkArgs? args = null, CustomResourceOptions? opts = null)
    public ServiceNetwork(String name, ServiceNetworkArgs args)
public ServiceNetwork(String name, ServiceNetworkArgs args, CustomResourceOptions options)

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

    Parameters

    name string
    The unique name of the resource.
    args ServiceNetworkArgs
    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 ServiceNetworkArgs
    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 ServiceNetworkArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceNetworkArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceNetworkArgs
    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 serviceNetworkResource = new Aws.VpcLattice.ServiceNetwork("serviceNetworkResource", new()
{
    AuthType = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := vpclattice.NewServiceNetwork(ctx, "serviceNetworkResource", &vpclattice.ServiceNetworkArgs{
	AuthType: pulumi.String("string"),
	Name:     pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var serviceNetworkResource = new ServiceNetwork("serviceNetworkResource", ServiceNetworkArgs.builder()
    .authType("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    service_network_resource = aws.vpclattice.ServiceNetwork("serviceNetworkResource",
    auth_type="string",
    name="string",
    tags={
        "string": "string",
    })

    const serviceNetworkResource = new aws.vpclattice.ServiceNetwork("serviceNetworkResource", {
    authType: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:vpclattice:ServiceNetwork
properties:
    authType: string
    name: string
    tags:
        string: string

    ServiceNetwork 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 ServiceNetwork resource accepts the following input properties:

    AuthType string
    Type of IAM policy. Either NONE or AWS_IAM.
    Name string

    Name of the service network

    The following arguments are optional:

    Tags Dictionary<string, string>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    AuthType string
    Type of IAM policy. Either NONE or AWS_IAM.
    Name string

    Name of the service network

    The following arguments are optional:

    Tags map[string]string
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    authType String
    Type of IAM policy. Either NONE or AWS_IAM.
    name String

    Name of the service network

    The following arguments are optional:

    tags Map<String,String>
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    authType string
    Type of IAM policy. Either NONE or AWS_IAM.
    name string

    Name of the service network

    The following arguments are optional:

    tags {[key: string]: string}
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    auth_type str
    Type of IAM policy. Either NONE or AWS_IAM.
    name str

    Name of the service network

    The following arguments are optional:

    tags Mapping[str, str]
    Key-value mapping of resource tags. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    authType String
    Type of IAM policy. Either NONE or AWS_IAM.
    name String

    Name of the service network

    The following arguments are optional:

    tags Map<String>
    Key-value mapping of resource tags. 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 ServiceNetwork resource produces the following output properties:

    Arn string
    ARN of the Service Network.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll Dictionary<string, string>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Service Network.
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Service Network.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Service Network.
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Service Network.
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Service Network.
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    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 ServiceNetwork Resource

    Get an existing ServiceNetwork 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?: ServiceNetworkState, opts?: CustomResourceOptions): ServiceNetwork
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        auth_type: Optional[str] = None,
        name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ServiceNetwork
    func GetServiceNetwork(ctx *Context, name string, id IDInput, state *ServiceNetworkState, opts ...ResourceOption) (*ServiceNetwork, error)
    public static ServiceNetwork Get(string name, Input<string> id, ServiceNetworkState? state, CustomResourceOptions? opts = null)
    public static ServiceNetwork get(String name, Output<String> id, ServiceNetworkState 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
    ARN of the Service Network.
    AuthType string
    Type of IAM policy. Either NONE or AWS_IAM.
    Name string

    Name of the service network

    The following arguments are optional:

    Tags Dictionary<string, string>
    Key-value mapping of resource tags. 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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    ARN of the Service Network.
    AuthType string
    Type of IAM policy. Either NONE or AWS_IAM.
    Name string

    Name of the service network

    The following arguments are optional:

    Tags map[string]string
    Key-value mapping of resource tags. 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
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Service Network.
    authType String
    Type of IAM policy. Either NONE or AWS_IAM.
    name String

    Name of the service network

    The following arguments are optional:

    tags Map<String,String>
    Key-value mapping of resource tags. 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>
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    ARN of the Service Network.
    authType string
    Type of IAM policy. Either NONE or AWS_IAM.
    name string

    Name of the service network

    The following arguments are optional:

    tags {[key: string]: string}
    Key-value mapping of resource tags. 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}
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    ARN of the Service Network.
    auth_type str
    Type of IAM policy. Either NONE or AWS_IAM.
    name str

    Name of the service network

    The following arguments are optional:

    tags Mapping[str, str]
    Key-value mapping of resource tags. 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]
    Map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    ARN of the Service Network.
    authType String
    Type of IAM policy. Either NONE or AWS_IAM.
    name String

    Name of the service network

    The following arguments are optional:

    tags Map<String>
    Key-value mapping of resource tags. 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>
    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 VPC Lattice Service Network using the id. For example:

    $ pulumi import aws:vpclattice/serviceNetwork:ServiceNetwork example sn-0158f91c1e3358dba

    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.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws