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

aws.outposts.getOutposts

Explore with Pulumi AI

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

    Provides details about multiple Outposts.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = aws.outposts.getOutposts({
        siteId: id,
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.outposts.get_outposts(site_id=id)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/outposts"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := outposts.GetOutposts(ctx, &outposts.GetOutpostsArgs{
    			SiteId: pulumi.StringRef(id),
    		}, nil)
    		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 = Aws.Outposts.GetOutposts.Invoke(new()
        {
            SiteId = id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.outposts.OutpostsFunctions;
    import com.pulumi.aws.outposts.inputs.GetOutpostsArgs;
    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 = OutpostsFunctions.getOutposts(GetOutpostsArgs.builder()
                .siteId(id)
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: aws:outposts:getOutposts
          Arguments:
            siteId: ${id}
    

    Using getOutposts

    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 getOutposts(args: GetOutpostsArgs, opts?: InvokeOptions): Promise<GetOutpostsResult>
    function getOutpostsOutput(args: GetOutpostsOutputArgs, opts?: InvokeOptions): Output<GetOutpostsResult>
    def get_outposts(availability_zone: Optional[str] = None,
                     availability_zone_id: Optional[str] = None,
                     owner_id: Optional[str] = None,
                     site_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOutpostsResult
    def get_outposts_output(availability_zone: Optional[pulumi.Input[str]] = None,
                     availability_zone_id: Optional[pulumi.Input[str]] = None,
                     owner_id: Optional[pulumi.Input[str]] = None,
                     site_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOutpostsResult]
    func GetOutposts(ctx *Context, args *GetOutpostsArgs, opts ...InvokeOption) (*GetOutpostsResult, error)
    func GetOutpostsOutput(ctx *Context, args *GetOutpostsOutputArgs, opts ...InvokeOption) GetOutpostsResultOutput

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

    public static class GetOutposts 
    {
        public static Task<GetOutpostsResult> InvokeAsync(GetOutpostsArgs args, InvokeOptions? opts = null)
        public static Output<GetOutpostsResult> Invoke(GetOutpostsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetOutpostsResult> getOutposts(GetOutpostsArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:outposts/getOutposts:getOutposts
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AvailabilityZone string
    Availability Zone name.
    AvailabilityZoneId string
    Availability Zone identifier.
    OwnerId string
    AWS Account identifier of the Outpost owner.
    SiteId string
    Site identifier.
    AvailabilityZone string
    Availability Zone name.
    AvailabilityZoneId string
    Availability Zone identifier.
    OwnerId string
    AWS Account identifier of the Outpost owner.
    SiteId string
    Site identifier.
    availabilityZone String
    Availability Zone name.
    availabilityZoneId String
    Availability Zone identifier.
    ownerId String
    AWS Account identifier of the Outpost owner.
    siteId String
    Site identifier.
    availabilityZone string
    Availability Zone name.
    availabilityZoneId string
    Availability Zone identifier.
    ownerId string
    AWS Account identifier of the Outpost owner.
    siteId string
    Site identifier.
    availability_zone str
    Availability Zone name.
    availability_zone_id str
    Availability Zone identifier.
    owner_id str
    AWS Account identifier of the Outpost owner.
    site_id str
    Site identifier.
    availabilityZone String
    Availability Zone name.
    availabilityZoneId String
    Availability Zone identifier.
    ownerId String
    AWS Account identifier of the Outpost owner.
    siteId String
    Site identifier.

    getOutposts Result

    The following output properties are available:

    Arns List<string>
    Set of Amazon Resource Names (ARNs).
    AvailabilityZone string
    AvailabilityZoneId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids List<string>
    Set of identifiers.
    OwnerId string
    SiteId string
    Arns []string
    Set of Amazon Resource Names (ARNs).
    AvailabilityZone string
    AvailabilityZoneId string
    Id string
    The provider-assigned unique ID for this managed resource.
    Ids []string
    Set of identifiers.
    OwnerId string
    SiteId string
    arns List<String>
    Set of Amazon Resource Names (ARNs).
    availabilityZone String
    availabilityZoneId String
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    Set of identifiers.
    ownerId String
    siteId String
    arns string[]
    Set of Amazon Resource Names (ARNs).
    availabilityZone string
    availabilityZoneId string
    id string
    The provider-assigned unique ID for this managed resource.
    ids string[]
    Set of identifiers.
    ownerId string
    siteId string
    arns Sequence[str]
    Set of Amazon Resource Names (ARNs).
    availability_zone str
    availability_zone_id str
    id str
    The provider-assigned unique ID for this managed resource.
    ids Sequence[str]
    Set of identifiers.
    owner_id str
    site_id str
    arns List<String>
    Set of Amazon Resource Names (ARNs).
    availabilityZone String
    availabilityZoneId String
    id String
    The provider-assigned unique ID for this managed resource.
    ids List<String>
    Set of identifiers.
    ownerId String
    siteId String

    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