This page documents the language specification for the aws package. If you're looking for help working with the inputs, outputs, or functions of aws resources in a Pulumi program, please see the resource documentation for examples and API reference.

worklink¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.worklink.Fleet(resource_name, opts=None, audit_stream_arn=None, device_ca_certificate=None, display_name=None, identity_provider=None, name=None, network=None, optimize_for_end_user_location=None, __props__=None, __name__=None, __opts__=None)¶

import pulumi
import pulumi_aws as aws

example = aws.worklink.Fleet("example")

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
audit_stream_arn (pulumi.Input[str]) – The ARN of the Amazon Kinesis data stream that receives the audit events.
device_ca_certificate (pulumi.Input[str]) – The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
display_name (pulumi.Input[str]) – The name of the fleet.
identity_provider (pulumi.Input[dict]) – Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
name (pulumi.Input[str]) – A region-unique name for the AMI.
network (pulumi.Input[dict]) – Provide this to allow manage the company network configuration for the fleet. Fields documented below.
optimize_for_end_user_location (pulumi.Input[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.

The identity_provider object supports the following:

samlMetadata (pulumi.Input[str]) - The SAML metadata document provided by the customer’s identity provider.
type (pulumi.Input[str]) - The type of identity provider.

The network object supports the following:

security_group_ids (pulumi.Input[list]) - A list of security group IDs associated with access to the provided subnets.
subnet_ids (pulumi.Input[list]) - A list of subnet IDs used for X-ENI connections from Amazon WorkLink rendering containers.
vpc_id (pulumi.Input[str]) - The VPC ID with connectivity to associated websites.

arn: pulumi.Output[str] = None¶: The ARN of the created WorkLink Fleet.

audit_stream_arn: pulumi.Output[str] = None¶: The ARN of the Amazon Kinesis data stream that receives the audit events.

company_code: pulumi.Output[str] = None¶: The identifier used by users to sign in to the Amazon WorkLink app.

created_time: pulumi.Output[str] = None¶: The time that the fleet was created.

device_ca_certificate: pulumi.Output[str] = None¶: The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.

display_name: pulumi.Output[str] = None¶: The name of the fleet.

identity_provider: pulumi.Output[dict] = None¶

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

samlMetadata (str) - The SAML metadata document provided by the customer’s identity provider.
type (str) - The type of identity provider.

last_updated_time: pulumi.Output[str] = None¶: The time that the fleet was last updated.

name: pulumi.Output[str] = None¶: A region-unique name for the AMI.

network: pulumi.Output[dict] = None¶

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

security_group_ids (list) - A list of security group IDs associated with access to the provided subnets.
subnet_ids (list) - 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.

optimize_for_end_user_location: pulumi.Output[bool] = None¶: 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.

static get(resource_name, id, opts=None, arn=None, audit_stream_arn=None, company_code=None, created_time=None, device_ca_certificate=None, display_name=None, identity_provider=None, last_updated_time=None, name=None, network=None, optimize_for_end_user_location=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the created WorkLink Fleet.
audit_stream_arn (pulumi.Input[str]) – The ARN of the Amazon Kinesis data stream that receives the audit events.
company_code (pulumi.Input[str]) – The identifier used by users to sign in to the Amazon WorkLink app.
created_time (pulumi.Input[str]) – The time that the fleet was created.
device_ca_certificate (pulumi.Input[str]) – The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
display_name (pulumi.Input[str]) – The name of the fleet.
identity_provider (pulumi.Input[dict]) – Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
last_updated_time (pulumi.Input[str]) – The time that the fleet was last updated.
name (pulumi.Input[str]) – A region-unique name for the AMI.
network (pulumi.Input[dict]) – Provide this to allow manage the company network configuration for the fleet. Fields documented below.
optimize_for_end_user_location (pulumi.Input[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.

The identity_provider object supports the following:

samlMetadata (pulumi.Input[str]) - The SAML metadata document provided by the customer’s identity provider.
type (pulumi.Input[str]) - The type of identity provider.

The network object supports the following:

security_group_ids (pulumi.Input[list]) - A list of security group IDs associated with access to the provided subnets.
subnet_ids (pulumi.Input[list]) - A list of subnet IDs used for X-ENI connections from Amazon WorkLink rendering containers.
vpc_id (pulumi.Input[str]) - The VPC ID with connectivity to associated websites.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.worklink.WebsiteCertificateAuthorityAssociation(resource_name, opts=None, certificate=None, display_name=None, fleet_arn=None, __props__=None, __name__=None, __opts__=None)¶

import pulumi
import pulumi_aws as aws

example = aws.worklink.Fleet("example")
test = aws.worklink.WebsiteCertificateAuthorityAssociation("test",
    certificate=(lambda path: open(path).read())("certificate.pem"),
    fleet_arn=aws_worklink_fleet["test"]["arn"])

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
certificate (pulumi.Input[str]) – The root certificate of the Certificate Authority.
display_name (pulumi.Input[str]) – The certificate name to display.
fleet_arn (pulumi.Input[str]) – The ARN of the fleet.

certificate: pulumi.Output[str] = None¶: The root certificate of the Certificate Authority.

display_name: pulumi.Output[str] = None¶: The certificate name to display.

fleet_arn: pulumi.Output[str] = None¶: The ARN of the fleet.

website_ca_id: pulumi.Output[str] = None¶: A unique identifier for the Certificate Authority.

static get(resource_name, id, opts=None, certificate=None, display_name=None, fleet_arn=None, website_ca_id=None)¶

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

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
certificate (pulumi.Input[str]) – The root certificate of the Certificate Authority.
display_name (pulumi.Input[str]) – The certificate name to display.
fleet_arn (pulumi.Input[str]) – The ARN of the fleet.
website_ca_id (pulumi.Input[str]) – A unique identifier for the Certificate Authority.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

worklink¶

On This Page