Module worklink

@pulumi/aws > worklink

class Fleet

extends CustomResource

Example Usage

Basic usage:

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

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

Network Configuration Usage:

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

const example = new aws.worklink.Fleet("example", {
    network: {
        securityGroupIds: [aws_security_group_test.id],
        subnetIds: [aws_subnet_test.map(v => v.id)],
        vpcId: aws_vpc_test.id,
    },
});

Identity Provider Configuration Usage:

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: {
        samlMetadata: fs.readFileSync("saml-metadata.xml", "utf-8"),
        type: "SAML",
    },
});

constructor

new Fleet(name: string, args?: FleetArgs, opts?: pulumi.CustomResourceOptions)

Create a Fleet resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: FleetState, opts?: pulumi.CustomResourceOptions): Fleet

Get an existing Fleet resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property arn

public arn: pulumi.Output<string>;

The ARN of the created WorkLink Fleet.

property auditStreamArn

public auditStreamArn: pulumi.Output<string | undefined>;

The ARN of the Amazon Kinesis data stream that receives the audit events.

property companyCode

public companyCode: pulumi.Output<string>;

The identifier used by users to sign in to the Amazon WorkLink app.

property createdTime

public createdTime: pulumi.Output<string>;

The time that the fleet was created.

property deviceCaCertificate

public deviceCaCertificate: pulumi.Output<string | undefined>;

The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

property displayName

public displayName: pulumi.Output<string | undefined>;

The name of the fleet.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identityProvider

public identityProvider: pulumi.Output<{
    samlMetadata: string;
    type: string;
} | undefined>;

Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.

property lastUpdatedTime

public lastUpdatedTime: pulumi.Output<string>;

The time that the fleet was last updated.

property name

public name: pulumi.Output<string>;

A region-unique name for the AMI.

property network

public network: pulumi.Output<{
    securityGroupIds: string[];
    subnetIds: string[];
    vpcId: string;
} | undefined>;

Provide this to allow manage the company network configuration for the fleet. Fields documented below.

property optimizeForEndUserLocation

public optimizeForEndUserLocation: pulumi.Output<boolean | undefined>;

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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

interface FleetArgs

The set of arguments for constructing a Fleet resource.

property auditStreamArn

auditStreamArn?: pulumi.Input<string>;

The ARN of the Amazon Kinesis data stream that receives the audit events.

property deviceCaCertificate

deviceCaCertificate?: pulumi.Input<string>;

The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

property displayName

displayName?: pulumi.Input<string>;

The name of the fleet.

property identityProvider

identityProvider?: pulumi.Input<{
    samlMetadata: pulumi.Input<string>;
    type: pulumi.Input<string>;
}>;

Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.

property name

name?: pulumi.Input<string>;

A region-unique name for the AMI.

property network

network?: pulumi.Input<{
    securityGroupIds: pulumi.Input<pulumi.Input<string>[]>;
    subnetIds: pulumi.Input<pulumi.Input<string>[]>;
    vpcId: pulumi.Input<string>;
}>;

Provide this to allow manage the company network configuration for the fleet. Fields documented below.

property optimizeForEndUserLocation

optimizeForEndUserLocation?: pulumi.Input<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.

interface FleetState

Input properties used for looking up and filtering Fleet resources.

property arn

arn?: pulumi.Input<string>;

The ARN of the created WorkLink Fleet.

property auditStreamArn

auditStreamArn?: pulumi.Input<string>;

The ARN of the Amazon Kinesis data stream that receives the audit events.

property companyCode

companyCode?: pulumi.Input<string>;

The identifier used by users to sign in to the Amazon WorkLink app.

property createdTime

createdTime?: pulumi.Input<string>;

The time that the fleet was created.

property deviceCaCertificate

deviceCaCertificate?: pulumi.Input<string>;

The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

property displayName

displayName?: pulumi.Input<string>;

The name of the fleet.

property identityProvider

identityProvider?: pulumi.Input<{
    samlMetadata: pulumi.Input<string>;
    type: pulumi.Input<string>;
}>;

Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.

property lastUpdatedTime

lastUpdatedTime?: pulumi.Input<string>;

The time that the fleet was last updated.

property name

name?: pulumi.Input<string>;

A region-unique name for the AMI.

property network

network?: pulumi.Input<{
    securityGroupIds: pulumi.Input<pulumi.Input<string>[]>;
    subnetIds: pulumi.Input<pulumi.Input<string>[]>;
    vpcId: pulumi.Input<string>;
}>;

Provide this to allow manage the company network configuration for the fleet. Fields documented below.

property optimizeForEndUserLocation

optimizeForEndUserLocation?: pulumi.Input<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.