Fleet

Import

WorkLink can be imported using the ARN, e.g.,

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

Example Usage

Basic usage

using System.Collections.Generic;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.WorkLink.Fleet("example");

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/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", nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.worklink.Fleet;
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");

    }
}
import pulumi
import pulumi_aws as aws

example = aws.worklink.Fleet("example")
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.worklink.Fleet("example", {});
resources:
  example:
    type: aws:worklink:Fleet

Network Configuration Usage

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()
    {
        Network = new Aws.WorkLink.Inputs.FleetNetworkArgs
        {
            VpcId = aws_vpc.Test.Id,
            SubnetIds = new[]
            {
                aws_subnet.Test.Select(__item => __item.Id).ToList(),
            },
            SecurityGroupIds = new[]
            {
                aws_security_group.Test.Id,
            },
        },
    });

});

Coming soon!

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()        
            .network(FleetNetworkArgs.builder()
                .vpcId(aws_vpc.test().id())
                .subnetIds(aws_subnet.test().stream().map(element -> element.id()).collect(toList()))
                .securityGroupIds(aws_security_group.test().id())
                .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

example = aws.worklink.Fleet("example", network=aws.worklink.FleetNetworkArgs(
    vpc_id=aws_vpc["test"]["id"],
    subnet_ids=[[__item["id"] for __item in aws_subnet["test"]]],
    security_group_ids=[aws_security_group["test"]["id"]],
))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.worklink.Fleet("example", {network: {
    vpcId: aws_vpc.test.id,
    subnetIds: [aws_subnet.test.map(__item => __item.id)],
    securityGroupIds: [aws_security_group.test.id],
}});

Coming soon!

Identity Provider Configuration Usage

using System.Collections.Generic;
using System.IO;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var test = new Aws.WorkLink.Fleet("test", new()
    {
        IdentityProvider = new Aws.WorkLink.Inputs.FleetIdentityProviderArgs
        {
            Type = "SAML",
            SamlMetadata = File.ReadAllText("saml-metadata.xml"),
        },
    });

});
package main

import (
	"io/ioutil"

	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/worklink"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func readFileOrPanic(path string) pulumi.StringPtrInput {
	data, err := ioutil.ReadFile(path)
	if err != nil {
		panic(err.Error())
	}
	return pulumi.String(string(data))
}

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := worklink.NewFleet(ctx, "test", &worklink.FleetArgs{
			IdentityProvider: &worklink.FleetIdentityProviderArgs{
				Type:         pulumi.String("SAML"),
				SamlMetadata: readFileOrPanic("saml-metadata.xml"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
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()        
            .identityProvider(FleetIdentityProviderArgs.builder()
                .type("SAML")
                .samlMetadata(Files.readString(Paths.get("saml-metadata.xml")))
                .build())
            .build());

    }
}
import pulumi
import pulumi_aws as aws

test = aws.worklink.Fleet("test", identity_provider=aws.worklink.FleetIdentityProviderArgs(
    type="SAML",
    saml_metadata=(lambda path: open(path).read())("saml-metadata.xml"),
))
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
import * as fs from "fs";

const test = new aws.worklink.Fleet("test", {identityProvider: {
    type: "SAML",
    samlMetadata: fs.readFileSync("saml-metadata.xml"),
}});
resources:
  test:
    type: aws:worklink:Fleet
    properties:
      identityProvider:
        type: SAML
        samlMetadata:
          fn::readFile: saml-metadata.xml

Create Fleet Resource

new Fleet(name: string, args?: FleetArgs, opts?: CustomResourceOptions);
@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)
@overload
def Fleet(resource_name: str,
          args: Optional[FleetArgs] = None,
          opts: Optional[ResourceOptions] = 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.

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.

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 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.

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.

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 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.

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 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.

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.

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.

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 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.

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.

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 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.

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 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.

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.

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.

Supporting Types

FleetIdentityProvider

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

SecurityGroupIds List<string>

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

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.

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.

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.

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.

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.

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.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes

This Pulumi package is based on the aws Terraform Provider.