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

aws.vpclattice.Service

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.

    Example Usage

    Basic Usage

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

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

    import pulumi
import pulumi_aws as aws

example = aws.vpclattice.Service("example",
    name="example",
    auth_type="AWS_IAM",
    custom_domain_name="example.com")

    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.NewService(ctx, "example", &vpclattice.ServiceArgs{
			Name:             pulumi.String("example"),
			AuthType:         pulumi.String("AWS_IAM"),
			CustomDomainName: pulumi.String("example.com"),
		})
		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.Service("example", new()
    {
        Name = "example",
        AuthType = "AWS_IAM",
        CustomDomainName = "example.com",
    });

});

    package generated_program;

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

    }
}

    resources:
  example:
    type: aws:vpclattice:Service
    properties:
      name: example
      authType: AWS_IAM
      customDomainName: example.com

    Create Service Resource

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

    Constructor syntax

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

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

    type: aws:vpclattice:Service
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 ServiceArgs
    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 ServiceArgs
    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 ServiceArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ServiceArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ServiceArgs
    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 exampleserviceResourceResourceFromVpclatticeservice = new Aws.VpcLattice.Service("exampleserviceResourceResourceFromVpclatticeservice", new()
{
    AuthType = "string",
    CertificateArn = "string",
    CustomDomainName = "string",
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := vpclattice.NewService(ctx, "exampleserviceResourceResourceFromVpclatticeservice", &vpclattice.ServiceArgs{
	AuthType:         pulumi.String("string"),
	CertificateArn:   pulumi.String("string"),
	CustomDomainName: pulumi.String("string"),
	Name:             pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleserviceResourceResourceFromVpclatticeservice = new Service("exampleserviceResourceResourceFromVpclatticeservice", ServiceArgs.builder()
    .authType("string")
    .certificateArn("string")
    .customDomainName("string")
    .name("string")
    .tags(Map.of("string", "string"))
    .build());

    exampleservice_resource_resource_from_vpclatticeservice = aws.vpclattice.Service("exampleserviceResourceResourceFromVpclatticeservice",
    auth_type="string",
    certificate_arn="string",
    custom_domain_name="string",
    name="string",
    tags={
        "string": "string",
    })

    const exampleserviceResourceResourceFromVpclatticeservice = new aws.vpclattice.Service("exampleserviceResourceResourceFromVpclatticeservice", {
    authType: "string",
    certificateArn: "string",
    customDomainName: "string",
    name: "string",
    tags: {
        string: "string",
    },
});

    type: aws:vpclattice:Service
properties:
    authType: string
    certificateArn: string
    customDomainName: string
    name: string
    tags:
        string: string

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

    AuthType string
    Type of IAM policy. Either NONE or AWS_IAM.
    CertificateArn string
    Amazon Resource Name (ARN) of the certificate.
    CustomDomainName string
    Custom domain name of the service.
    Name string

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    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.
    CertificateArn string
    Amazon Resource Name (ARN) of the certificate.
    CustomDomainName string
    Custom domain name of the service.
    Name string

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    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.
    certificateArn String
    Amazon Resource Name (ARN) of the certificate.
    customDomainName String
    Custom domain name of the service.
    name String

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    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.
    certificateArn string
    Amazon Resource Name (ARN) of the certificate.
    customDomainName string
    Custom domain name of the service.
    name string

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    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.
    certificate_arn str
    Amazon Resource Name (ARN) of the certificate.
    custom_domain_name str
    Custom domain name of the service.
    name str

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    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.
    certificateArn String
    Amazon Resource Name (ARN) of the certificate.
    customDomainName String
    Custom domain name of the service.
    name String

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    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 Service resource produces the following output properties:

    Arn string
    ARN of the service.
    DnsEntries List<ServiceDnsEntry>
    DNS name of the service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the service.
    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.
    DnsEntries []ServiceDnsEntry
    DNS name of the service.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    Status of the service.
    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.
    dnsEntries List<ServiceDnsEntry>
    DNS name of the service.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the service.
    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.
    dnsEntries ServiceDnsEntry[]
    DNS name of the service.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    Status of the service.
    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.
    dns_entries Sequence[ServiceDnsEntry]
    DNS name of the service.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    Status of the service.
    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.
    dnsEntries List<Property Map>
    DNS name of the service.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    Status of the service.
    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 Service Resource

    Get an existing Service 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?: ServiceState, opts?: CustomResourceOptions): Service
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        auth_type: Optional[str] = None,
        certificate_arn: Optional[str] = None,
        custom_domain_name: Optional[str] = None,
        dns_entries: Optional[Sequence[ServiceDnsEntryArgs]] = None,
        name: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Service
    func GetService(ctx *Context, name string, id IDInput, state *ServiceState, opts ...ResourceOption) (*Service, error)
    public static Service Get(string name, Input<string> id, ServiceState? state, CustomResourceOptions? opts = null)
    public static Service get(String name, Output<String> id, ServiceState 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.
    AuthType string
    Type of IAM policy. Either NONE or AWS_IAM.
    CertificateArn string
    Amazon Resource Name (ARN) of the certificate.
    CustomDomainName string
    Custom domain name of the service.
    DnsEntries List<ServiceDnsEntry>
    DNS name of the service.
    Name string

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    The following arguments are optional:

    Status string
    Status of the service.
    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.
    AuthType string
    Type of IAM policy. Either NONE or AWS_IAM.
    CertificateArn string
    Amazon Resource Name (ARN) of the certificate.
    CustomDomainName string
    Custom domain name of the service.
    DnsEntries []ServiceDnsEntryArgs
    DNS name of the service.
    Name string

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    The following arguments are optional:

    Status string
    Status of the service.
    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.
    authType String
    Type of IAM policy. Either NONE or AWS_IAM.
    certificateArn String
    Amazon Resource Name (ARN) of the certificate.
    customDomainName String
    Custom domain name of the service.
    dnsEntries List<ServiceDnsEntry>
    DNS name of the service.
    name String

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    The following arguments are optional:

    status String
    Status of the service.
    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.
    authType string
    Type of IAM policy. Either NONE or AWS_IAM.
    certificateArn string
    Amazon Resource Name (ARN) of the certificate.
    customDomainName string
    Custom domain name of the service.
    dnsEntries ServiceDnsEntry[]
    DNS name of the service.
    name string

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    The following arguments are optional:

    status string
    Status of the service.
    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.
    auth_type str
    Type of IAM policy. Either NONE or AWS_IAM.
    certificate_arn str
    Amazon Resource Name (ARN) of the certificate.
    custom_domain_name str
    Custom domain name of the service.
    dns_entries Sequence[ServiceDnsEntryArgs]
    DNS name of the service.
    name str

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    The following arguments are optional:

    status str
    Status of the service.
    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.
    authType String
    Type of IAM policy. Either NONE or AWS_IAM.
    certificateArn String
    Amazon Resource Name (ARN) of the certificate.
    customDomainName String
    Custom domain name of the service.
    dnsEntries List<Property Map>
    DNS name of the service.
    name String

    Name of the service. The name must be unique within the account. The valid characters are a-z, 0-9, and hyphens (-). You can't use a hyphen as the first or last character, or immediately after another hyphen.Must be between 3 and 40 characters in length.

    The following arguments are optional:

    status String
    Status of the service.
    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

    ServiceDnsEntry, ServiceDnsEntryArgs

    Import

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

    $ pulumi import aws:vpclattice/service:Service example svc-06728e2357ea55f8a

    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