1. Packages
  2. AWS Classic
  3. API Docs
  4. worklink
  5. Fleet

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.worklink.Fleet

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Example Usage

    Basic usage:

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.worklink.Fleet("example", {name: "example"});
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.worklink.Fleet("example", name="example")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/worklink"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := worklink.NewFleet(ctx, "example", &worklink.FleetArgs{
    			Name: pulumi.String("example"),
    		})
    		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.WorkLink.Fleet("example", new()
        {
            Name = "example",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.worklink.Fleet;
    import com.pulumi.aws.worklink.FleetArgs;
    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 Fleet("example", FleetArgs.builder()
                .name("example")
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:worklink:Fleet
        properties:
          name: example
    

    Network Configuration Usage:

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.worklink.Fleet("example", {
        name: "example",
        network: {
            vpcId: testAwsVpc.id,
            subnetIds: [testAwsSubnet.map(__item => __item.id)],
            securityGroupIds: [test.id],
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.worklink.Fleet("example",
        name="example",
        network=aws.worklink.FleetNetworkArgs(
            vpc_id=test_aws_vpc["id"],
            subnet_ids=[[__item["id"] for __item in test_aws_subnet]],
            security_group_ids=[test["id"]],
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/worklink"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
    _, err := worklink.NewFleet(ctx, "example", &worklink.FleetArgs{
    Name: pulumi.String("example"),
    Network: &worklink.FleetNetworkArgs{
    VpcId: pulumi.Any(testAwsVpc.Id),
    SubnetIds: pulumi.StringArray{
    %!v(PANIC=Format method: fatal: A failure has occurred: unlowered splat expression @ example.pp:4,25-44),
    },
    SecurityGroupIds: pulumi.StringArray{
    test.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.WorkLink.Fleet("example", new()
        {
            Name = "example",
            Network = new Aws.WorkLink.Inputs.FleetNetworkArgs
            {
                VpcId = testAwsVpc.Id,
                SubnetIds = new[]
                {
                    testAwsSubnet.Select(__item => __item.Id).ToList(),
                },
                SecurityGroupIds = new[]
                {
                    test.Id,
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.worklink.Fleet;
    import com.pulumi.aws.worklink.FleetArgs;
    import com.pulumi.aws.worklink.inputs.FleetNetworkArgs;
    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 Fleet("example", FleetArgs.builder()
                .name("example")
                .network(FleetNetworkArgs.builder()
                    .vpcId(testAwsVpc.id())
                    .subnetIds(testAwsSubnet.stream().map(element -> element.id()).collect(toList()))
                    .securityGroupIds(test.id())
                    .build())
                .build());
    
        }
    }
    
    Coming soon!
    

    Identity Provider Configuration Usage:

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    import * as std from "@pulumi/std";
    
    const test = new aws.worklink.Fleet("test", {
        name: "tf-worklink-fleet",
        identityProvider: {
            type: "SAML",
            samlMetadata: std.file({
                input: "saml-metadata.xml",
            }).then(invoke => invoke.result),
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    import pulumi_std as std
    
    test = aws.worklink.Fleet("test",
        name="tf-worklink-fleet",
        identity_provider=aws.worklink.FleetIdentityProviderArgs(
            type="SAML",
            saml_metadata=std.file(input="saml-metadata.xml").result,
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/worklink"
    	"github.com/pulumi/pulumi-std/sdk/go/std"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		invokeFile, err := std.File(ctx, &std.FileArgs{
    			Input: "saml-metadata.xml",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = worklink.NewFleet(ctx, "test", &worklink.FleetArgs{
    			Name: pulumi.String("tf-worklink-fleet"),
    			IdentityProvider: &worklink.FleetIdentityProviderArgs{
    				Type:         pulumi.String("SAML"),
    				SamlMetadata: invokeFile.Result,
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    using Std = Pulumi.Std;
    
    return await Deployment.RunAsync(() => 
    {
        var test = new Aws.WorkLink.Fleet("test", new()
        {
            Name = "tf-worklink-fleet",
            IdentityProvider = new Aws.WorkLink.Inputs.FleetIdentityProviderArgs
            {
                Type = "SAML",
                SamlMetadata = Std.File.Invoke(new()
                {
                    Input = "saml-metadata.xml",
                }).Apply(invoke => invoke.Result),
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.worklink.Fleet;
    import com.pulumi.aws.worklink.FleetArgs;
    import com.pulumi.aws.worklink.inputs.FleetIdentityProviderArgs;
    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 test = new Fleet("test", FleetArgs.builder()
                .name("tf-worklink-fleet")
                .identityProvider(FleetIdentityProviderArgs.builder()
                    .type("SAML")
                    .samlMetadata(StdFunctions.file(FileArgs.builder()
                        .input("saml-metadata.xml")
                        .build()).result())
                    .build())
                .build());
    
        }
    }
    
    resources:
      test:
        type: aws:worklink:Fleet
        properties:
          name: tf-worklink-fleet
          identityProvider:
            type: SAML
            samlMetadata:
              fn::invoke:
                Function: std:file
                Arguments:
                  input: saml-metadata.xml
                Return: result
    

    Create Fleet Resource

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

    Constructor syntax

    new Fleet(name: string, args?: FleetArgs, opts?: CustomResourceOptions);
    @overload
    def Fleet(resource_name: str,
              args: Optional[FleetArgs] = None,
              opts: Optional[ResourceOptions] = None)
    
    @overload
    def Fleet(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              audit_stream_arn: Optional[str] = None,
              device_ca_certificate: Optional[str] = None,
              display_name: Optional[str] = None,
              identity_provider: Optional[FleetIdentityProviderArgs] = None,
              name: Optional[str] = None,
              network: Optional[FleetNetworkArgs] = None,
              optimize_for_end_user_location: Optional[bool] = None)
    func NewFleet(ctx *Context, name string, args *FleetArgs, opts ...ResourceOption) (*Fleet, error)
    public Fleet(string name, FleetArgs? args = null, CustomResourceOptions? opts = null)
    public Fleet(String name, FleetArgs args)
    public Fleet(String name, FleetArgs args, CustomResourceOptions options)
    
    type: aws:worklink:Fleet
    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 FleetArgs
    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 FleetArgs
    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 FleetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args FleetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args FleetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var examplefleetResourceResourceFromWorklinkfleet = new Aws.WorkLink.Fleet("examplefleetResourceResourceFromWorklinkfleet", new()
    {
        AuditStreamArn = "string",
        DeviceCaCertificate = "string",
        DisplayName = "string",
        IdentityProvider = new Aws.WorkLink.Inputs.FleetIdentityProviderArgs
        {
            SamlMetadata = "string",
            Type = "string",
        },
        Name = "string",
        Network = new Aws.WorkLink.Inputs.FleetNetworkArgs
        {
            SecurityGroupIds = new[]
            {
                "string",
            },
            SubnetIds = new[]
            {
                "string",
            },
            VpcId = "string",
        },
        OptimizeForEndUserLocation = false,
    });
    
    example, err := worklink.NewFleet(ctx, "examplefleetResourceResourceFromWorklinkfleet", &worklink.FleetArgs{
    	AuditStreamArn:      pulumi.String("string"),
    	DeviceCaCertificate: pulumi.String("string"),
    	DisplayName:         pulumi.String("string"),
    	IdentityProvider: &worklink.FleetIdentityProviderArgs{
    		SamlMetadata: pulumi.String("string"),
    		Type:         pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	Network: &worklink.FleetNetworkArgs{
    		SecurityGroupIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		SubnetIds: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		VpcId: pulumi.String("string"),
    	},
    	OptimizeForEndUserLocation: pulumi.Bool(false),
    })
    
    var examplefleetResourceResourceFromWorklinkfleet = new Fleet("examplefleetResourceResourceFromWorklinkfleet", FleetArgs.builder()
        .auditStreamArn("string")
        .deviceCaCertificate("string")
        .displayName("string")
        .identityProvider(FleetIdentityProviderArgs.builder()
            .samlMetadata("string")
            .type("string")
            .build())
        .name("string")
        .network(FleetNetworkArgs.builder()
            .securityGroupIds("string")
            .subnetIds("string")
            .vpcId("string")
            .build())
        .optimizeForEndUserLocation(false)
        .build());
    
    examplefleet_resource_resource_from_worklinkfleet = aws.worklink.Fleet("examplefleetResourceResourceFromWorklinkfleet",
        audit_stream_arn="string",
        device_ca_certificate="string",
        display_name="string",
        identity_provider=aws.worklink.FleetIdentityProviderArgs(
            saml_metadata="string",
            type="string",
        ),
        name="string",
        network=aws.worklink.FleetNetworkArgs(
            security_group_ids=["string"],
            subnet_ids=["string"],
            vpc_id="string",
        ),
        optimize_for_end_user_location=False)
    
    const examplefleetResourceResourceFromWorklinkfleet = new aws.worklink.Fleet("examplefleetResourceResourceFromWorklinkfleet", {
        auditStreamArn: "string",
        deviceCaCertificate: "string",
        displayName: "string",
        identityProvider: {
            samlMetadata: "string",
            type: "string",
        },
        name: "string",
        network: {
            securityGroupIds: ["string"],
            subnetIds: ["string"],
            vpcId: "string",
        },
        optimizeForEndUserLocation: false,
    });
    
    type: aws:worklink:Fleet
    properties:
        auditStreamArn: string
        deviceCaCertificate: string
        displayName: string
        identityProvider:
            samlMetadata: string
            type: string
        name: string
        network:
            securityGroupIds:
                - string
            subnetIds:
                - string
            vpcId: string
        optimizeForEndUserLocation: false
    

    Fleet Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Fleet resource accepts the following input properties:

    AuditStreamArn string
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    DeviceCaCertificate string
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    DisplayName string
    The name of the fleet.
    IdentityProvider FleetIdentityProvider
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    Name string
    A region-unique name for the AMI.
    Network FleetNetwork
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    OptimizeForEndUserLocation bool

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    AuditStreamArn string
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    DeviceCaCertificate string
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    DisplayName string
    The name of the fleet.
    IdentityProvider FleetIdentityProviderArgs
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    Name string
    A region-unique name for the AMI.
    Network FleetNetworkArgs
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    OptimizeForEndUserLocation bool

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    auditStreamArn String
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    deviceCaCertificate String
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    displayName String
    The name of the fleet.
    identityProvider FleetIdentityProvider
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    name String
    A region-unique name for the AMI.
    network FleetNetwork
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    optimizeForEndUserLocation Boolean

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    auditStreamArn string
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    deviceCaCertificate string
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    displayName string
    The name of the fleet.
    identityProvider FleetIdentityProvider
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    name string
    A region-unique name for the AMI.
    network FleetNetwork
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    optimizeForEndUserLocation boolean

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    audit_stream_arn str
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    device_ca_certificate str
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    display_name str
    The name of the fleet.
    identity_provider FleetIdentityProviderArgs
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    name str
    A region-unique name for the AMI.
    network FleetNetworkArgs
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    optimize_for_end_user_location bool

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    auditStreamArn String
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    deviceCaCertificate String
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    displayName String
    The name of the fleet.
    identityProvider Property Map
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    name String
    A region-unique name for the AMI.
    network Property Map
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    optimizeForEndUserLocation Boolean

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Fleet resource produces the following output properties:

    Arn string
    The ARN of the created WorkLink Fleet.
    CompanyCode string
    The identifier used by users to sign in to the Amazon WorkLink app.
    CreatedTime string
    The time that the fleet was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    The time that the fleet was last updated.
    Arn string
    The ARN of the created WorkLink Fleet.
    CompanyCode string
    The identifier used by users to sign in to the Amazon WorkLink app.
    CreatedTime string
    The time that the fleet was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedTime string
    The time that the fleet was last updated.
    arn String
    The ARN of the created WorkLink Fleet.
    companyCode String
    The identifier used by users to sign in to the Amazon WorkLink app.
    createdTime String
    The time that the fleet was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    The time that the fleet was last updated.
    arn string
    The ARN of the created WorkLink Fleet.
    companyCode string
    The identifier used by users to sign in to the Amazon WorkLink app.
    createdTime string
    The time that the fleet was created.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime string
    The time that the fleet was last updated.
    arn str
    The ARN of the created WorkLink Fleet.
    company_code str
    The identifier used by users to sign in to the Amazon WorkLink app.
    created_time str
    The time that the fleet was created.
    id str
    The provider-assigned unique ID for this managed resource.
    last_updated_time str
    The time that the fleet was last updated.
    arn String
    The ARN of the created WorkLink Fleet.
    companyCode String
    The identifier used by users to sign in to the Amazon WorkLink app.
    createdTime String
    The time that the fleet was created.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedTime String
    The time that the fleet was last updated.

    Look up Existing Fleet Resource

    Get an existing Fleet 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?: FleetState, opts?: CustomResourceOptions): Fleet
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            arn: Optional[str] = None,
            audit_stream_arn: Optional[str] = None,
            company_code: Optional[str] = None,
            created_time: Optional[str] = None,
            device_ca_certificate: Optional[str] = None,
            display_name: Optional[str] = None,
            identity_provider: Optional[FleetIdentityProviderArgs] = None,
            last_updated_time: Optional[str] = None,
            name: Optional[str] = None,
            network: Optional[FleetNetworkArgs] = None,
            optimize_for_end_user_location: Optional[bool] = None) -> Fleet
    func GetFleet(ctx *Context, name string, id IDInput, state *FleetState, opts ...ResourceOption) (*Fleet, error)
    public static Fleet Get(string name, Input<string> id, FleetState? state, CustomResourceOptions? opts = null)
    public static Fleet get(String name, Output<String> id, FleetState 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 created WorkLink Fleet.
    AuditStreamArn string
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    CompanyCode string
    The identifier used by users to sign in to the Amazon WorkLink app.
    CreatedTime string
    The time that the fleet was created.
    DeviceCaCertificate string
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    DisplayName string
    The name of the fleet.
    IdentityProvider FleetIdentityProvider
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    LastUpdatedTime string
    The time that the fleet was last updated.
    Name string
    A region-unique name for the AMI.
    Network FleetNetwork
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    OptimizeForEndUserLocation bool

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    Arn string
    The ARN of the created WorkLink Fleet.
    AuditStreamArn string
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    CompanyCode string
    The identifier used by users to sign in to the Amazon WorkLink app.
    CreatedTime string
    The time that the fleet was created.
    DeviceCaCertificate string
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    DisplayName string
    The name of the fleet.
    IdentityProvider FleetIdentityProviderArgs
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    LastUpdatedTime string
    The time that the fleet was last updated.
    Name string
    A region-unique name for the AMI.
    Network FleetNetworkArgs
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    OptimizeForEndUserLocation bool

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    arn String
    The ARN of the created WorkLink Fleet.
    auditStreamArn String
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    companyCode String
    The identifier used by users to sign in to the Amazon WorkLink app.
    createdTime String
    The time that the fleet was created.
    deviceCaCertificate String
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    displayName String
    The name of the fleet.
    identityProvider FleetIdentityProvider
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    lastUpdatedTime String
    The time that the fleet was last updated.
    name String
    A region-unique name for the AMI.
    network FleetNetwork
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    optimizeForEndUserLocation Boolean

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    arn string
    The ARN of the created WorkLink Fleet.
    auditStreamArn string
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    companyCode string
    The identifier used by users to sign in to the Amazon WorkLink app.
    createdTime string
    The time that the fleet was created.
    deviceCaCertificate string
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    displayName string
    The name of the fleet.
    identityProvider FleetIdentityProvider
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    lastUpdatedTime string
    The time that the fleet was last updated.
    name string
    A region-unique name for the AMI.
    network FleetNetwork
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    optimizeForEndUserLocation boolean

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    arn str
    The ARN of the created WorkLink Fleet.
    audit_stream_arn str
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    company_code str
    The identifier used by users to sign in to the Amazon WorkLink app.
    created_time str
    The time that the fleet was created.
    device_ca_certificate str
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    display_name str
    The name of the fleet.
    identity_provider FleetIdentityProviderArgs
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    last_updated_time str
    The time that the fleet was last updated.
    name str
    A region-unique name for the AMI.
    network FleetNetworkArgs
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    optimize_for_end_user_location bool

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    arn String
    The ARN of the created WorkLink Fleet.
    auditStreamArn String
    The ARN of the Amazon Kinesis data stream that receives the audit events. Kinesis data stream name must begin with "AmazonWorkLink-".
    companyCode String
    The identifier used by users to sign in to the Amazon WorkLink app.
    createdTime String
    The time that the fleet was created.
    deviceCaCertificate String
    The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
    displayName String
    The name of the fleet.
    identityProvider Property Map
    Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
    lastUpdatedTime String
    The time that the fleet was last updated.
    name String
    A region-unique name for the AMI.
    network Property Map
    Provide this to allow manage the company network configuration for the fleet. Fields documented below.
    optimizeForEndUserLocation Boolean

    The option to optimize for better performance by routing traffic through the closest AWS Region to users, which may be outside of your home Region. Defaults to true.

    network requires the following:

    NOTE: network is cannot removed without force recreating.

    Supporting Types

    FleetIdentityProvider, FleetIdentityProviderArgs

    SamlMetadata string
    The SAML metadata document provided by the customer’s identity provider.
    Type string
    The type of identity provider.
    SamlMetadata string
    The SAML metadata document provided by the customer’s identity provider.
    Type string
    The type of identity provider.
    samlMetadata String
    The SAML metadata document provided by the customer’s identity provider.
    type String
    The type of identity provider.
    samlMetadata string
    The SAML metadata document provided by the customer’s identity provider.
    type string
    The type of identity provider.
    saml_metadata str
    The SAML metadata document provided by the customer’s identity provider.
    type str
    The type of identity provider.
    samlMetadata String
    The SAML metadata document provided by the customer’s identity provider.
    type String
    The type of identity provider.

    FleetNetwork, FleetNetworkArgs

    SecurityGroupIds List<string>

    A list of security group IDs associated with access to the provided subnets.

    identity_provider requires the following:

    NOTE: identity_provider cannot be removed without force recreating.

    SubnetIds List<string>
    A list of subnet IDs used for X-ENI connections from Amazon WorkLink rendering containers.
    VpcId string
    The VPC ID with connectivity to associated websites.
    SecurityGroupIds []string

    A list of security group IDs associated with access to the provided subnets.

    identity_provider requires the following:

    NOTE: identity_provider cannot be removed without force recreating.

    SubnetIds []string
    A list of subnet IDs used for X-ENI connections from Amazon WorkLink rendering containers.
    VpcId string
    The VPC ID with connectivity to associated websites.
    securityGroupIds List<String>

    A list of security group IDs associated with access to the provided subnets.

    identity_provider requires the following:

    NOTE: identity_provider cannot be removed without force recreating.

    subnetIds List<String>
    A list of subnet IDs used for X-ENI connections from Amazon WorkLink rendering containers.
    vpcId String
    The VPC ID with connectivity to associated websites.
    securityGroupIds string[]

    A list of security group IDs associated with access to the provided subnets.

    identity_provider requires the following:

    NOTE: identity_provider cannot be removed without force recreating.

    subnetIds string[]
    A list of subnet IDs used for X-ENI connections from Amazon WorkLink rendering containers.
    vpcId string
    The VPC ID with connectivity to associated websites.
    security_group_ids Sequence[str]

    A list of security group IDs associated with access to the provided subnets.

    identity_provider requires the following:

    NOTE: identity_provider cannot be removed without force recreating.

    subnet_ids Sequence[str]
    A list of subnet IDs used for X-ENI connections from Amazon WorkLink rendering containers.
    vpc_id str
    The VPC ID with connectivity to associated websites.
    securityGroupIds List<String>

    A list of security group IDs associated with access to the provided subnets.

    identity_provider requires the following:

    NOTE: identity_provider cannot be removed without force recreating.

    subnetIds List<String>
    A list of subnet IDs used for X-ENI connections from Amazon WorkLink rendering containers.
    vpcId String
    The VPC ID with connectivity to associated websites.

    Import

    Using pulumi import, import WorkLink using the ARN. For example:

    $ pulumi import aws:worklink/fleet:Fleet test arn:aws:worklink::123456789012:fleet/example
    

    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

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi