1. Packages
  2. AWS
  3. API Docs
  4. vpclattice
  5. ServiceNetworkServiceAssociation
AWS v6.64.0 published on Friday, Dec 6, 2024 by Pulumi

aws.vpclattice.ServiceNetworkServiceAssociation

Explore with Pulumi AI

aws logo
AWS v6.64.0 published on Friday, Dec 6, 2024 by Pulumi

    Resource for managing an AWS VPC Lattice Service Network Service Association.

    Example Usage

    Basic Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.vpclattice.ServiceNetworkServiceAssociation("example", {
        serviceIdentifier: exampleAwsVpclatticeService.id,
        serviceNetworkIdentifier: exampleAwsVpclatticeServiceNetwork.id,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.vpclattice.ServiceNetworkServiceAssociation("example",
        service_identifier=example_aws_vpclattice_service["id"],
        service_network_identifier=example_aws_vpclattice_service_network["id"])
    
    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.NewServiceNetworkServiceAssociation(ctx, "example", &vpclattice.ServiceNetworkServiceAssociationArgs{
    			ServiceIdentifier:        pulumi.Any(exampleAwsVpclatticeService.Id),
    			ServiceNetworkIdentifier: pulumi.Any(exampleAwsVpclatticeServiceNetwork.Id),
    		})
    		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.ServiceNetworkServiceAssociation("example", new()
        {
            ServiceIdentifier = exampleAwsVpclatticeService.Id,
            ServiceNetworkIdentifier = exampleAwsVpclatticeServiceNetwork.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.vpclattice.ServiceNetworkServiceAssociation;
    import com.pulumi.aws.vpclattice.ServiceNetworkServiceAssociationArgs;
    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 ServiceNetworkServiceAssociation("example", ServiceNetworkServiceAssociationArgs.builder()
                .serviceIdentifier(exampleAwsVpclatticeService.id())
                .serviceNetworkIdentifier(exampleAwsVpclatticeServiceNetwork.id())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:vpclattice:ServiceNetworkServiceAssociation
        properties:
          serviceIdentifier: ${exampleAwsVpclatticeService.id}
          serviceNetworkIdentifier: ${exampleAwsVpclatticeServiceNetwork.id}
    

    Create ServiceNetworkServiceAssociation Resource

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

    Constructor syntax

    new ServiceNetworkServiceAssociation(name: string, args: ServiceNetworkServiceAssociationArgs, opts?: CustomResourceOptions);
    @overload
    def ServiceNetworkServiceAssociation(resource_name: str,
                                         args: ServiceNetworkServiceAssociationArgs,
                                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def ServiceNetworkServiceAssociation(resource_name: str,
                                         opts: Optional[ResourceOptions] = None,
                                         service_identifier: Optional[str] = None,
                                         service_network_identifier: Optional[str] = None,
                                         tags: Optional[Mapping[str, str]] = None)
    func NewServiceNetworkServiceAssociation(ctx *Context, name string, args ServiceNetworkServiceAssociationArgs, opts ...ResourceOption) (*ServiceNetworkServiceAssociation, error)
    public ServiceNetworkServiceAssociation(string name, ServiceNetworkServiceAssociationArgs args, CustomResourceOptions? opts = null)
    public ServiceNetworkServiceAssociation(String name, ServiceNetworkServiceAssociationArgs args)
    public ServiceNetworkServiceAssociation(String name, ServiceNetworkServiceAssociationArgs args, CustomResourceOptions options)
    
    type: aws:vpclattice:ServiceNetworkServiceAssociation
    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 ServiceNetworkServiceAssociationArgs
    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 ServiceNetworkServiceAssociationArgs
    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 ServiceNetworkServiceAssociationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceNetworkServiceAssociationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceNetworkServiceAssociationArgs
    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 serviceNetworkServiceAssociationResource = new Aws.VpcLattice.ServiceNetworkServiceAssociation("serviceNetworkServiceAssociationResource", new()
    {
        ServiceIdentifier = "string",
        ServiceNetworkIdentifier = "string",
        Tags = 
        {
            { "string", "string" },
        },
    });
    
    example, err := vpclattice.NewServiceNetworkServiceAssociation(ctx, "serviceNetworkServiceAssociationResource", &vpclattice.ServiceNetworkServiceAssociationArgs{
    	ServiceIdentifier:        pulumi.String("string"),
    	ServiceNetworkIdentifier: pulumi.String("string"),
    	Tags: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    })
    
    var serviceNetworkServiceAssociationResource = new ServiceNetworkServiceAssociation("serviceNetworkServiceAssociationResource", ServiceNetworkServiceAssociationArgs.builder()
        .serviceIdentifier("string")
        .serviceNetworkIdentifier("string")
        .tags(Map.of("string", "string"))
        .build());
    
    service_network_service_association_resource = aws.vpclattice.ServiceNetworkServiceAssociation("serviceNetworkServiceAssociationResource",
        service_identifier="string",
        service_network_identifier="string",
        tags={
            "string": "string",
        })
    
    const serviceNetworkServiceAssociationResource = new aws.vpclattice.ServiceNetworkServiceAssociation("serviceNetworkServiceAssociationResource", {
        serviceIdentifier: "string",
        serviceNetworkIdentifier: "string",
        tags: {
            string: "string",
        },
    });
    
    type: aws:vpclattice:ServiceNetworkServiceAssociation
    properties:
        serviceIdentifier: string
        serviceNetworkIdentifier: string
        tags:
            string: string
    

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

    ServiceIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service.
    ServiceNetworkIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. 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.
    ServiceIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service.
    ServiceNetworkIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. 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.
    serviceIdentifier String
    The ID or Amazon Resource Identifier (ARN) of the service.
    serviceNetworkIdentifier String
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. 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.
    serviceIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service.
    serviceNetworkIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. 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.
    service_identifier str
    The ID or Amazon Resource Identifier (ARN) of the service.
    service_network_identifier str
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. 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.
    serviceIdentifier String
    The ID or Amazon Resource Identifier (ARN) of the service.
    serviceNetworkIdentifier String
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. 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 ServiceNetworkServiceAssociation resource produces the following output properties:

    Arn string
    The ARN of the Association.
    CreatedBy string
    The account that created the association.
    CustomDomainName string
    The custom domain name of the service.
    DnsEntries List<ServiceNetworkServiceAssociationDnsEntry>
    The DNS name of the service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    CreatedBy string
    The account that created the association.
    CustomDomainName string
    The custom domain name of the service.
    DnsEntries []ServiceNetworkServiceAssociationDnsEntry
    The DNS name of the service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    createdBy String
    The account that created the association.
    customDomainName String
    The custom domain name of the service.
    dnsEntries List<ServiceNetworkServiceAssociationDnsEntry>
    The DNS name of the service.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    createdBy string
    The account that created the association.
    customDomainName string
    The custom domain name of the service.
    dnsEntries ServiceNetworkServiceAssociationDnsEntry[]
    The DNS name of the service.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    created_by str
    The account that created the association.
    custom_domain_name str
    The custom domain name of the service.
    dns_entries Sequence[ServiceNetworkServiceAssociationDnsEntry]
    The DNS name of the service.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    createdBy String
    The account that created the association.
    customDomainName String
    The custom domain name of the service.
    dnsEntries List<Property Map>
    The DNS name of the service.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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 ServiceNetworkServiceAssociation Resource

    Get an existing ServiceNetworkServiceAssociation 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?: ServiceNetworkServiceAssociationState, opts?: CustomResourceOptions): ServiceNetworkServiceAssociation
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            created_by: Optional[str] = None,
            custom_domain_name: Optional[str] = None,
            dns_entries: Optional[Sequence[ServiceNetworkServiceAssociationDnsEntryArgs]] = None,
            service_identifier: Optional[str] = None,
            service_network_identifier: Optional[str] = None,
            status: Optional[str] = None,
            tags: Optional[Mapping[str, str]] = None,
            tags_all: Optional[Mapping[str, str]] = None) -> ServiceNetworkServiceAssociation
    func GetServiceNetworkServiceAssociation(ctx *Context, name string, id IDInput, state *ServiceNetworkServiceAssociationState, opts ...ResourceOption) (*ServiceNetworkServiceAssociation, error)
    public static ServiceNetworkServiceAssociation Get(string name, Input<string> id, ServiceNetworkServiceAssociationState? state, CustomResourceOptions? opts = null)
    public static ServiceNetworkServiceAssociation get(String name, Output<String> id, ServiceNetworkServiceAssociationState 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 Association.
    CreatedBy string
    The account that created the association.
    CustomDomainName string
    The custom domain name of the service.
    DnsEntries List<ServiceNetworkServiceAssociationDnsEntry>
    The DNS name of the service.
    ServiceIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service.
    ServiceNetworkIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. The following arguments are optional:
    Status string
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    CreatedBy string
    The account that created the association.
    CustomDomainName string
    The custom domain name of the service.
    DnsEntries []ServiceNetworkServiceAssociationDnsEntryArgs
    The DNS name of the service.
    ServiceIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service.
    ServiceNetworkIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. The following arguments are optional:
    Status string
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    createdBy String
    The account that created the association.
    customDomainName String
    The custom domain name of the service.
    dnsEntries List<ServiceNetworkServiceAssociationDnsEntry>
    The DNS name of the service.
    serviceIdentifier String
    The ID or Amazon Resource Identifier (ARN) of the service.
    serviceNetworkIdentifier String
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. The following arguments are optional:
    status String
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    createdBy string
    The account that created the association.
    customDomainName string
    The custom domain name of the service.
    dnsEntries ServiceNetworkServiceAssociationDnsEntry[]
    The DNS name of the service.
    serviceIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service.
    serviceNetworkIdentifier string
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. The following arguments are optional:
    status string
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    created_by str
    The account that created the association.
    custom_domain_name str
    The custom domain name of the service.
    dns_entries Sequence[ServiceNetworkServiceAssociationDnsEntryArgs]
    The DNS name of the service.
    service_identifier str
    The ID or Amazon Resource Identifier (ARN) of the service.
    service_network_identifier str
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. The following arguments are optional:
    status str
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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
    The ARN of the Association.
    createdBy String
    The account that created the association.
    customDomainName String
    The custom domain name of the service.
    dnsEntries List<Property Map>
    The DNS name of the service.
    serviceIdentifier String
    The ID or Amazon Resource Identifier (ARN) of the service.
    serviceNetworkIdentifier String
    The ID or Amazon Resource Identifier (ARN) of the service network. You must use the ARN if the resources specified in the operation are in different accounts. The following arguments are optional:
    status String
    The operations status. Valid Values are CREATE_IN_PROGRESS | ACTIVE | DELETE_IN_PROGRESS | CREATE_FAILED | DELETE_FAILED
    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.

    Supporting Types

    ServiceNetworkServiceAssociationDnsEntry, ServiceNetworkServiceAssociationDnsEntryArgs

    DomainName string
    The domain name of the service.
    HostedZoneId string
    The ID of the hosted zone.
    DomainName string
    The domain name of the service.
    HostedZoneId string
    The ID of the hosted zone.
    domainName String
    The domain name of the service.
    hostedZoneId String
    The ID of the hosted zone.
    domainName string
    The domain name of the service.
    hostedZoneId string
    The ID of the hosted zone.
    domain_name str
    The domain name of the service.
    hosted_zone_id str
    The ID of the hosted zone.
    domainName String
    The domain name of the service.
    hostedZoneId String
    The ID of the hosted zone.

    Import

    Using pulumi import, import VPC Lattice Service Network Service Association using the id. For example:

    $ pulumi import aws:vpclattice/serviceNetworkServiceAssociation:ServiceNetworkServiceAssociation example snsa-05e2474658a88f6ba
    

    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.64.0 published on Friday, Dec 6, 2024 by Pulumi