Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. vpclattice
  5. getService
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.vpclattice.getService

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Data source 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 = aws.vpclattice.getService({
    name: "example",
});
Copy
import pulumi
import pulumi_aws as aws

example = aws.vpclattice.get_service(name="example")
Copy
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.LookupService(ctx, &vpclattice.LookupServiceArgs{
			Name: pulumi.StringRef("example"),
		}, nil)
		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 = Aws.VpcLattice.GetService.Invoke(new()
    {
        Name = "example",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.vpclattice.VpclatticeFunctions;
import com.pulumi.aws.vpclattice.inputs.GetServiceArgs;
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) {
        final var example = VpclatticeFunctions.getService(GetServiceArgs.builder()
            .name("example")
            .build());

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: aws:vpclattice:getService
      arguments:
        name: example
Copy

Using getService

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getService(args: GetServiceArgs, opts?: InvokeOptions): Promise<GetServiceResult>
function getServiceOutput(args: GetServiceOutputArgs, opts?: InvokeOptions): Output<GetServiceResult>
Copy
def get_service(name: Optional[str] = None,
                service_identifier: Optional[str] = None,
                tags: Optional[Mapping[str, str]] = None,
                opts: Optional[InvokeOptions] = None) -> GetServiceResult
def get_service_output(name: Optional[pulumi.Input[str]] = None,
                service_identifier: Optional[pulumi.Input[str]] = None,
                tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetServiceResult]
Copy
func LookupService(ctx *Context, args *LookupServiceArgs, opts ...InvokeOption) (*LookupServiceResult, error)
func LookupServiceOutput(ctx *Context, args *LookupServiceOutputArgs, opts ...InvokeOption) LookupServiceResultOutput
Copy

> Note: This function is named LookupService in the Go SDK.

public static class GetService 
{
    public static Task<GetServiceResult> InvokeAsync(GetServiceArgs args, InvokeOptions? opts = null)
    public static Output<GetServiceResult> Invoke(GetServiceInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
public static Output<GetServiceResult> getService(GetServiceArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:vpclattice/getService:getService
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name string
Service name.
ServiceIdentifier string
ID or Amazon Resource Name (ARN) of the service.
Tags Dictionary<string, string>
List of tags associated with the service.
Name string
Service name.
ServiceIdentifier string
ID or Amazon Resource Name (ARN) of the service.
Tags map[string]string
List of tags associated with the service.
name String
Service name.
serviceIdentifier String
ID or Amazon Resource Name (ARN) of the service.
tags Map<String,String>
List of tags associated with the service.
name string
Service name.
serviceIdentifier string
ID or Amazon Resource Name (ARN) of the service.
tags {[key: string]: string}
List of tags associated with the service.
name str
Service name.
service_identifier str
ID or Amazon Resource Name (ARN) of the service.
tags Mapping[str, str]
List of tags associated with the service.
name String
Service name.
serviceIdentifier String
ID or Amazon Resource Name (ARN) of the service.
tags Map<String>
List of tags associated with the service.

getService Result

The following output properties are available:

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<GetServiceDnsEntry>
List of objects with DNS names.
Id string
The provider-assigned unique ID for this managed resource.
Name string
ServiceIdentifier string
Status string
Status of the service.
Tags Dictionary<string, string>
List of tags associated with the service.
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 []GetServiceDnsEntry
List of objects with DNS names.
Id string
The provider-assigned unique ID for this managed resource.
Name string
ServiceIdentifier string
Status string
Status of the service.
Tags map[string]string
List of tags associated with the service.
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<GetServiceDnsEntry>
List of objects with DNS names.
id String
The provider-assigned unique ID for this managed resource.
name String
serviceIdentifier String
status String
Status of the service.
tags Map<String,String>
List of tags associated with the service.
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 GetServiceDnsEntry[]
List of objects with DNS names.
id string
The provider-assigned unique ID for this managed resource.
name string
serviceIdentifier string
status string
Status of the service.
tags {[key: string]: string}
List of tags associated with the service.
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[GetServiceDnsEntry]
List of objects with DNS names.
id str
The provider-assigned unique ID for this managed resource.
name str
service_identifier str
status str
Status of the service.
tags Mapping[str, str]
List of tags associated with the service.
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>
List of objects with DNS names.
id String
The provider-assigned unique ID for this managed resource.
name String
serviceIdentifier String
status String
Status of the service.
tags Map<String>
List of tags associated with the service.

Supporting Types

GetServiceDnsEntry

DomainName This property is required. string
DNS name for the service.
HostedZoneId This property is required. string
Hosted zone ID where the DNS name is registered.
DomainName This property is required. string
DNS name for the service.
HostedZoneId This property is required. string
Hosted zone ID where the DNS name is registered.
domainName This property is required. String
DNS name for the service.
hostedZoneId This property is required. String
Hosted zone ID where the DNS name is registered.
domainName This property is required. string
DNS name for the service.
hostedZoneId This property is required. string
Hosted zone ID where the DNS name is registered.
domain_name This property is required. str
DNS name for the service.
hosted_zone_id This property is required. str
Hosted zone ID where the DNS name is registered.
domainName This property is required. String
DNS name for the service.
hostedZoneId This property is required. String
Hosted zone ID where the DNS name is registered.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws