Class: AWSCDK::AppStream::CfnFleet

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggable, Interfaces::AWSAppstream::IFleetRef
Defined in:
app_stream/cfn_fleet.rb

Overview

The AWS::AppStream::Fleet resource creates a fleet for Amazon AppStream 2.0. A fleet consists of streaming instances that run a specified image when using Always-On or On-Demand.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnFleet

Create a new AWS::AppStream::Fleet.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::AppStream::CfnFleetProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'app_stream/cfn_fleet.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleetProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwc3RyZWFtLkNmbkZsZWV0UHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


195
196
197
 
# File 'app_stream/cfn_fleet.rb', line 195

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_appstream.CfnFleet", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_fleet(x) ⇒ Boolean

Checks whether the given object is a CfnFleet.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


97
98
99
100
 
# File 'app_stream/cfn_fleet.rb', line 97

def self.is_cfn_fleet(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appstream.CfnFleet", "isCfnFleet", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'app_stream/cfn_fleet.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :fleet_ref => { kind: :property, name: "fleetRef", is_optional: false },
    :tags => { kind: :property, name: "tags", is_optional: false },
    :instance_type => { kind: :property, name: "instanceType", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :compute_capacity => { kind: :property, name: "computeCapacity", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :disable_imdsv1 => { kind: :property, name: "disableImdsv1", is_optional: true },
    :disconnect_timeout_in_seconds => { kind: :property, name: "disconnectTimeoutInSeconds", is_optional: true },
    :display_name => { kind: :property, name: "displayName", is_optional: true },
    :domain_join_info => { kind: :property, name: "domainJoinInfo", is_optional: true },
    :enable_default_internet_access => { kind: :property, name: "enableDefaultInternetAccess", is_optional: true },
    :fleet_type => { kind: :property, name: "fleetType", is_optional: true },
    :iam_role_arn => { kind: :property, name: "iamRoleArn", is_optional: true },
    :idle_disconnect_timeout_in_seconds => { kind: :property, name: "idleDisconnectTimeoutInSeconds", is_optional: true },
    :image_arn => { kind: :property, name: "imageArn", is_optional: true },
    :image_name => { kind: :property, name: "imageName", is_optional: true },
    :max_concurrent_sessions => { kind: :property, name: "maxConcurrentSessions", is_optional: true },
    :max_sessions_per_instance => { kind: :property, name: "maxSessionsPerInstance", is_optional: true },
    :max_user_duration_in_seconds => { kind: :property, name: "maxUserDurationInSeconds", is_optional: true },
    :platform => { kind: :property, name: "platform", is_optional: true },
    :root_volume_config => { kind: :property, name: "rootVolumeConfig", is_optional: true },
    :session_script_s3_location => { kind: :property, name: "sessionScriptS3Location", is_optional: true },
    :stream_view => { kind: :property, name: "streamView", is_optional: true },
    :tags_raw => { kind: :property, name: "tagsRaw", is_optional: true },
    :usb_device_filter_strings => { kind: :property, name: "usbDeviceFilterStrings", is_optional: true },
    :vpc_config => { kind: :property, name: "vpcConfig", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



546
547
548
549
 
# File 'app_stream/cfn_fleet.rb', line 546

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



558
559
560
561
 
# File 'app_stream/cfn_fleet.rb', line 558

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



568
569
570
571
 
# File 'app_stream/cfn_fleet.rb', line 568

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



579
580
581
582
583
 
# File 'app_stream/cfn_fleet.rb', line 579

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


636
637
638
639
640
 
# File 'app_stream/cfn_fleet.rb', line 636

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



646
647
648
649
 
# File 'app_stream/cfn_fleet.rb', line 646

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



658
659
660
661
662
 
# File 'app_stream/cfn_fleet.rb', line 658

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



671
672
673
674
 
# File 'app_stream/cfn_fleet.rb', line 671

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



693
694
695
696
697
698
 
# File 'app_stream/cfn_fleet.rb', line 693

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_id ⇒ String

Returns:

  • (String) 


200
201
202
 
# File 'app_stream/cfn_fleet.rb', line 200

def attr_id()
  jsii_get_property("attrId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



148
149
150
 
# File 'app_stream/cfn_fleet.rb', line 148

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


153
154
155
 
# File 'app_stream/cfn_fleet.rb', line 153

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


702
703
704
705
 
# File 'app_stream/cfn_fleet.rb', line 702

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


158
159
160
 
# File 'app_stream/cfn_fleet.rb', line 158

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


165
166
167
 
# File 'app_stream/cfn_fleet.rb', line 165

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#compute_capacity ⇒ AWSCDK::IResolvable, ...

The desired capacity for the fleet.

Returns:



247
248
249
 
# File 'app_stream/cfn_fleet.rb', line 247

def compute_capacity()
  jsii_get_property("computeCapacity")
end

#compute_capacity=(value) ⇒ Object 



251
252
253
254
255
 
# File 'app_stream/cfn_fleet.rb', line 251

def compute_capacity=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::ComputeCapacityProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuQ29tcHV0ZUNhcGFjaXR5UHJvcGVydHkifV19fQ==")), "computeCapacity") unless value.nil?
  jsii_set_property("computeCapacity", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


110
111
112
 
# File 'app_stream/cfn_fleet.rb', line 110

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description to display.

Returns:

  • (String, nil) 


260
261
262
 
# File 'app_stream/cfn_fleet.rb', line 260

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



264
265
266
267
 
# File 'app_stream/cfn_fleet.rb', line 264

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#disable_imdsv1 ⇒ Boolean, ...

Returns:



270
271
272
 
# File 'app_stream/cfn_fleet.rb', line 270

def disable_imdsv1()
  jsii_get_property("disableImdsv1")
end

#disable_imdsv1=(value) ⇒ Object 



274
275
276
277
 
# File 'app_stream/cfn_fleet.rb', line 274

def disable_imdsv1=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "disableImdsv1") unless value.nil?
  jsii_set_property("disableImdsv1", value)
end

#disconnect_timeout_in_seconds ⇒ Numeric?

The amount of time that a streaming session remains active after users disconnect.

Returns:

  • (Numeric, nil) 


282
283
284
 
# File 'app_stream/cfn_fleet.rb', line 282

def disconnect_timeout_in_seconds()
  jsii_get_property("disconnectTimeoutInSeconds")
end

#disconnect_timeout_in_seconds=(value) ⇒ Object 



286
287
288
289
 
# File 'app_stream/cfn_fleet.rb', line 286

def disconnect_timeout_in_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "disconnectTimeoutInSeconds") unless value.nil?
  jsii_set_property("disconnectTimeoutInSeconds", value)
end

#display_name ⇒ String?

The fleet name to display.

Returns:

  • (String, nil) 


294
295
296
 
# File 'app_stream/cfn_fleet.rb', line 294

def display_name()
  jsii_get_property("displayName")
end

#display_name=(value) ⇒ Object 



298
299
300
301
 
# File 'app_stream/cfn_fleet.rb', line 298

def display_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "displayName") unless value.nil?
  jsii_set_property("displayName", value)
end

#domain_join_info ⇒ AWSCDK::IResolvable, ...

The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.

Returns:



306
307
308
 
# File 'app_stream/cfn_fleet.rb', line 306

def domain_join_info()
  jsii_get_property("domainJoinInfo")
end

#domain_join_info=(value) ⇒ Object 



310
311
312
313
314
 
# File 'app_stream/cfn_fleet.rb', line 310

def domain_join_info=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::DomainJoinInfoProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuRG9tYWluSm9pbkluZm9Qcm9wZXJ0eSJ9XX19")), "domainJoinInfo") unless value.nil?
  jsii_set_property("domainJoinInfo", value)
end

#enable_default_internet_access ⇒ Boolean, ...

Enables or disables default internet access for the fleet.

Returns:



319
320
321
 
# File 'app_stream/cfn_fleet.rb', line 319

def enable_default_internet_access()
  jsii_get_property("enableDefaultInternetAccess")
end

#enable_default_internet_access=(value) ⇒ Object 



323
324
325
326
 
# File 'app_stream/cfn_fleet.rb', line 323

def enable_default_internet_access=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableDefaultInternetAccess") unless value.nil?
  jsii_set_property("enableDefaultInternetAccess", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



170
171
172
 
# File 'app_stream/cfn_fleet.rb', line 170

def env()
  jsii_get_property("env")
end

#fleet_ref ⇒ AWSCDK::Interfaces::AWSAppstream::FleetReference

A reference to a Fleet resource.

Returns:



207
208
209
 
# File 'app_stream/cfn_fleet.rb', line 207

def fleet_ref()
  jsii_get_property("fleetRef")
end

#fleet_type ⇒ String?

The fleet type.

Returns:

  • (String, nil) 


331
332
333
 
# File 'app_stream/cfn_fleet.rb', line 331

def fleet_type()
  jsii_get_property("fleetType")
end

#fleet_type=(value) ⇒ Object 



335
336
337
338
 
# File 'app_stream/cfn_fleet.rb', line 335

def fleet_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fleetType") unless value.nil?
  jsii_set_property("fleetType", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



715
716
717
718
719
 
# File 'app_stream/cfn_fleet.rb', line 715

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



726
727
728
729
 
# File 'app_stream/cfn_fleet.rb', line 726

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#iam_role_arn ⇒ String?

The ARN of the IAM role that is applied to the fleet.

Returns:

  • (String, nil) 


343
344
345
 
# File 'app_stream/cfn_fleet.rb', line 343

def iam_role_arn()
  jsii_get_property("iamRoleArn")
end

#iam_role_arn=(value) ⇒ Object 



347
348
349
350
 
# File 'app_stream/cfn_fleet.rb', line 347

def iam_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "iamRoleArn") unless value.nil?
  jsii_set_property("iamRoleArn", value)
end

#idle_disconnect_timeout_in_seconds ⇒ Numeric?

The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins.

Returns:

  • (Numeric, nil) 


355
356
357
 
# File 'app_stream/cfn_fleet.rb', line 355

def idle_disconnect_timeout_in_seconds()
  jsii_get_property("idleDisconnectTimeoutInSeconds")
end

#idle_disconnect_timeout_in_seconds=(value) ⇒ Object 



359
360
361
362
 
# File 'app_stream/cfn_fleet.rb', line 359

def idle_disconnect_timeout_in_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "idleDisconnectTimeoutInSeconds") unless value.nil?
  jsii_set_property("idleDisconnectTimeoutInSeconds", value)
end

#image_arn ⇒ String?

The ARN of the public, private, or shared image to use.

Returns:

  • (String, nil) 


367
368
369
 
# File 'app_stream/cfn_fleet.rb', line 367

def image_arn()
  jsii_get_property("imageArn")
end

#image_arn=(value) ⇒ Object 



371
372
373
374
 
# File 'app_stream/cfn_fleet.rb', line 371

def image_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageArn") unless value.nil?
  jsii_set_property("imageArn", value)
end

#image_name ⇒ String?

The name of the image used to create the fleet.

Returns:

  • (String, nil) 


379
380
381
 
# File 'app_stream/cfn_fleet.rb', line 379

def image_name()
  jsii_get_property("imageName")
end

#image_name=(value) ⇒ Object 



383
384
385
386
 
# File 'app_stream/cfn_fleet.rb', line 383

def image_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageName") unless value.nil?
  jsii_set_property("imageName", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



796
797
798
799
 
# File 'app_stream/cfn_fleet.rb', line 796

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#instance_type ⇒ String

The instance type to use when launching fleet instances.

The following instance types are available for non-Elastic fleets:.

Returns:

  • (String) 


223
224
225
 
# File 'app_stream/cfn_fleet.rb', line 223

def instance_type()
  jsii_get_property("instanceType")
end

#instance_type=(value) ⇒ Object 



227
228
229
230
 
# File 'app_stream/cfn_fleet.rb', line 227

def instance_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "instanceType")
  jsii_set_property("instanceType", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


122
123
124
 
# File 'app_stream/cfn_fleet.rb', line 122

def logical_id()
  jsii_get_property("logicalId")
end

#max_concurrent_sessions ⇒ Numeric?

The maximum number of concurrent sessions that can be run on an Elastic fleet.

Returns:

  • (Numeric, nil) 


391
392
393
 
# File 'app_stream/cfn_fleet.rb', line 391

def max_concurrent_sessions()
  jsii_get_property("maxConcurrentSessions")
end

#max_concurrent_sessions=(value) ⇒ Object 



395
396
397
398
 
# File 'app_stream/cfn_fleet.rb', line 395

def max_concurrent_sessions=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxConcurrentSessions") unless value.nil?
  jsii_set_property("maxConcurrentSessions", value)
end

#max_sessions_per_instance ⇒ Numeric?

Max number of user sessions on an instance.

Returns:

  • (Numeric, nil) 


403
404
405
 
# File 'app_stream/cfn_fleet.rb', line 403

def max_sessions_per_instance()
  jsii_get_property("maxSessionsPerInstance")
end

#max_sessions_per_instance=(value) ⇒ Object 



407
408
409
410
 
# File 'app_stream/cfn_fleet.rb', line 407

def max_sessions_per_instance=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxSessionsPerInstance") unless value.nil?
  jsii_set_property("maxSessionsPerInstance", value)
end

#max_user_duration_in_seconds ⇒ Numeric?

The maximum amount of time that a streaming session can remain active, in seconds.

Returns:

  • (Numeric, nil) 


415
416
417
 
# File 'app_stream/cfn_fleet.rb', line 415

def max_user_duration_in_seconds()
  jsii_get_property("maxUserDurationInSeconds")
end

#max_user_duration_in_seconds=(value) ⇒ Object 



419
420
421
422
 
# File 'app_stream/cfn_fleet.rb', line 419

def max_user_duration_in_seconds=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "maxUserDurationInSeconds") unless value.nil?
  jsii_set_property("maxUserDurationInSeconds", value)
end

#name ⇒ String

A unique name for the fleet.

Returns:

  • (String) 


235
236
237
 
# File 'app_stream/cfn_fleet.rb', line 235

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



239
240
241
242
 
# File 'app_stream/cfn_fleet.rb', line 239

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


105
106
107
 
# File 'app_stream/cfn_fleet.rb', line 105

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



737
738
739
 
# File 'app_stream/cfn_fleet.rb', line 737

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



744
745
746
 
# File 'app_stream/cfn_fleet.rb', line 744

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



537
538
539
540
 
# File 'app_stream/cfn_fleet.rb', line 537

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#platform ⇒ String?

The platform of the fleet.

Returns:

  • (String, nil) 


427
428
429
 
# File 'app_stream/cfn_fleet.rb', line 427

def platform()
  jsii_get_property("platform")
end

#platform=(value) ⇒ Object 



431
432
433
434
 
# File 'app_stream/cfn_fleet.rb', line 431

def platform=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "platform") unless value.nil?
  jsii_set_property("platform", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


141
142
143
 
# File 'app_stream/cfn_fleet.rb', line 141

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



755
756
757
758
 
# File 'app_stream/cfn_fleet.rb', line 755

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


762
763
764
765
 
# File 'app_stream/cfn_fleet.rb', line 762

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



772
773
774
775
776
 
# File 'app_stream/cfn_fleet.rb', line 772

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#root_volume_config ⇒ AWSCDK::IResolvable, ...

Returns:



437
438
439
 
# File 'app_stream/cfn_fleet.rb', line 437

def root_volume_config()
  jsii_get_property("rootVolumeConfig")
end

#root_volume_config=(value) ⇒ Object 



441
442
443
444
445
 
# File 'app_stream/cfn_fleet.rb', line 441

def root_volume_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::VolumeConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuVm9sdW1lQ29uZmlnUHJvcGVydHkifV19fQ==")), "rootVolumeConfig") unless value.nil?
  jsii_set_property("rootVolumeConfig", value)
end

#session_script_s3_location ⇒ AWSCDK::IResolvable, ...

The S3 location of the session scripts configuration zip file.

Returns:



450
451
452
 
# File 'app_stream/cfn_fleet.rb', line 450

def session_script_s3_location()
  jsii_get_property("sessionScriptS3Location")
end

#session_script_s3_location=(value) ⇒ Object 



454
455
456
457
458
 
# File 'app_stream/cfn_fleet.rb', line 454

def session_script_s3_location=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::S3LocationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuUzNMb2NhdGlvblByb3BlcnR5In1dfX0=")), "sessionScriptS3Location") unless value.nil?
  jsii_set_property("sessionScriptS3Location", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



781
782
783
 
# File 'app_stream/cfn_fleet.rb', line 781

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



131
132
133
 
# File 'app_stream/cfn_fleet.rb', line 131

def stack()
  jsii_get_property("stack")
end

#stream_view ⇒ String?

The WorkSpaces Applications view that is displayed to your users when they stream from the fleet.

Returns:

  • (String, nil) 


463
464
465
 
# File 'app_stream/cfn_fleet.rb', line 463

def stream_view()
  jsii_get_property("streamView")
end

#stream_view=(value) ⇒ Object 



467
468
469
470
 
# File 'app_stream/cfn_fleet.rb', line 467

def stream_view=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "streamView") unless value.nil?
  jsii_set_property("streamView", value)
end

#tags ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



214
215
216
 
# File 'app_stream/cfn_fleet.rb', line 214

def tags()
  jsii_get_property("tags")
end

#tags_raw ⇒ Array<AWSCDK::CfnTag>?

An array of key-value pairs.

Returns:



475
476
477
 
# File 'app_stream/cfn_fleet.rb', line 475

def tags_raw()
  jsii_get_property("tagsRaw")
end

#tags_raw=(value) ⇒ Object 



479
480
481
482
483
 
# File 'app_stream/cfn_fleet.rb', line 479

def tags_raw=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tagsRaw") unless value.nil?
  jsii_set_property("tagsRaw", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



513
514
515
 
# File 'app_stream/cfn_fleet.rb', line 513

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


178
179
180
 
# File 'app_stream/cfn_fleet.rb', line 178

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


188
189
190
 
# File 'app_stream/cfn_fleet.rb', line 188

def updated_properties()
  jsii_get_property("updatedProperties")
end

#usb_device_filter_strings ⇒ Array<String>?

The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client.

Returns:

  • (Array<String>, nil) 


488
489
490
 
# File 'app_stream/cfn_fleet.rb', line 488

def usb_device_filter_strings()
  jsii_get_property("usbDeviceFilterStrings")
end

#usb_device_filter_strings=(value) ⇒ Object 



492
493
494
495
 
# File 'app_stream/cfn_fleet.rb', line 492

def usb_device_filter_strings=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "usbDeviceFilterStrings") unless value.nil?
  jsii_set_property("usbDeviceFilterStrings", value)
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


787
788
789
790
 
# File 'app_stream/cfn_fleet.rb', line 787

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_config ⇒ AWSCDK::IResolvable, ...

The VPC configuration for the fleet.

Returns:



500
501
502
 
# File 'app_stream/cfn_fleet.rb', line 500

def vpc_config()
  jsii_get_property("vpcConfig")
end

#vpc_config=(value) ⇒ Object 



504
505
506
507
508
 
# File 'app_stream/cfn_fleet.rb', line 504

def vpc_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::AppStream::CfnFleet::VPCConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRmxlZXQuVnBjQ29uZmlnUHJvcGVydHkifV19fQ==")), "vpcConfig") unless value.nil?
  jsii_set_property("vpcConfig", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


526
527
528
529
530
531
 
# File 'app_stream/cfn_fleet.rb', line 526

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end