Fleet
Create a Fleet Resource
new Fleet(name: string, args?: FleetArgs, opts?: CustomResourceOptions);def 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);public Fleet(string name, FleetArgs? args = null, CustomResourceOptions? opts = null)- 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.
- opts ResourceOptions
- A bag of options that control this 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.
Fleet Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.
Inputs
The Fleet resource accepts the following input properties:
- Audit
Stream stringArn The ARN of the Amazon Kinesis data stream that receives the audit events.
- Device
Ca stringCertificate The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
- Display
Name string The name of the fleet.
- Identity
Provider FleetIdentity Provider Args 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
Fleet
Network Args Provide this to allow manage the company network configuration for the fleet. Fields documented below.
- Optimize
For boolEnd User Location 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 stringArn The ARN of the Amazon Kinesis data stream that receives the audit events.
- Device
Ca stringCertificate The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
- Display
Name string The name of the fleet.
- Identity
Provider FleetIdentity Provider 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
Fleet
Network Provide this to allow manage the company network configuration for the fleet. Fields documented below.
- Optimize
For boolEnd User Location 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 stringArn The ARN of the Amazon Kinesis data stream that receives the audit events.
- device
Ca stringCertificate The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
- display
Name string The name of the fleet.
- identity
Provider FleetIdentity Provider 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
Fleet
Network Provide this to allow manage the company network configuration for the fleet. Fields documented below.
- optimize
For booleanEnd User Location 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_ strarn The ARN of the Amazon Kinesis data stream that receives the audit events.
- device_
ca_ strcertificate 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 Dict[FleetIdentity Provider] 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
Dict[Fleet
Network] Provide this to allow manage the company network configuration for the fleet. Fields documented below.
- optimize_
for_ boolend_ user_ location 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.
- Company
Code string The identifier used by users to sign in to the Amazon WorkLink app.
- Created
Time string The time that the fleet was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringTime The time that the fleet was last updated.
- Arn string
The ARN of the created WorkLink Fleet.
- Company
Code string The identifier used by users to sign in to the Amazon WorkLink app.
- Created
Time string The time that the fleet was created.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringTime The time that the fleet was last updated.
- arn string
The ARN of the created WorkLink Fleet.
- company
Code string The identifier used by users to sign in to the Amazon WorkLink app.
- created
Time string The time that the fleet was created.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Updated stringTime 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_ strtime The time that the fleet was last updated.
Look up an 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): Fleetstatic 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, __props__=None);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)- 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.
The following state arguments are supported:
- Arn string
The ARN of the created WorkLink Fleet.
- Audit
Stream stringArn The ARN of the Amazon Kinesis data stream that receives the audit events.
- Company
Code string The identifier used by users to sign in to the Amazon WorkLink app.
- Created
Time string The time that the fleet was created.
- Device
Ca stringCertificate The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
- Display
Name string The name of the fleet.
- Identity
Provider FleetIdentity Provider Args Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
- Last
Updated stringTime The time that the fleet was last updated.
- Name string
A region-unique name for the AMI.
- Network
Fleet
Network Args Provide this to allow manage the company network configuration for the fleet. Fields documented below.
- Optimize
For boolEnd User Location 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.
- Audit
Stream stringArn The ARN of the Amazon Kinesis data stream that receives the audit events.
- Company
Code string The identifier used by users to sign in to the Amazon WorkLink app.
- Created
Time string The time that the fleet was created.
- Device
Ca stringCertificate The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
- Display
Name string The name of the fleet.
- Identity
Provider FleetIdentity Provider Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
- Last
Updated stringTime The time that the fleet was last updated.
- Name string
A region-unique name for the AMI.
- Network
Fleet
Network Provide this to allow manage the company network configuration for the fleet. Fields documented below.
- Optimize
For boolEnd User Location 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.
- audit
Stream stringArn The ARN of the Amazon Kinesis data stream that receives the audit events.
- company
Code string The identifier used by users to sign in to the Amazon WorkLink app.
- created
Time string The time that the fleet was created.
- device
Ca stringCertificate The certificate chain, including intermediate certificates and the root certificate authority certificate used to issue device certificates.
- display
Name string The name of the fleet.
- identity
Provider FleetIdentity Provider Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
- last
Updated stringTime The time that the fleet was last updated.
- name string
A region-unique name for the AMI.
- network
Fleet
Network Provide this to allow manage the company network configuration for the fleet. Fields documented below.
- optimize
For booleanEnd User Location 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_ strarn The ARN of the Amazon Kinesis data stream that receives the audit events.
- 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_ strcertificate 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 Dict[FleetIdentity Provider] Provide this to allow manage the identity provider configuration for the fleet. Fields documented below.
- last_
updated_ strtime The time that the fleet was last updated.
- name str
A region-unique name for the AMI.
- network
Dict[Fleet
Network] Provide this to allow manage the company network configuration for the fleet. Fields documented below.
- optimize_
for_ boolend_ user_ location 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
- Saml
Metadata string The SAML metadata document provided by the customer’s identity provider.
- Type string
The type of identity provider.
- Saml
Metadata string The SAML metadata document provided by the customer’s identity provider.
- Type string
The type of identity provider.
- saml
Metadata 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.
FleetNetwork
- Security
Group List<string>Ids A list of security group IDs associated with access to the provided subnets.
- Subnet
Ids List<string> A list of subnet IDs used for X-ENI connections from Amazon WorkLink rendering containers.
- Vpc
Id string The VPC ID with connectivity to associated websites.
- security_
group_ List[str]ids A list of security group IDs associated with access to the provided subnets.
- subnet_
ids List[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.
Package Details
- Repository
- https://github.com/pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
awsTerraform Provider.