Class: AWSCDK::CodeBuild::CfnFleet

Inherits:
AWSCDK::CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSCodebuild::IFleetRef
Defined in:
code_build/cfn_fleet.rb

Overview

The AWS::CodeBuild::Fleet resource configures a compute fleet, a set of dedicated instances for your build environment.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ CfnFleet

Create a new AWS::CodeBuild::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::CodeBuild::CfnFleetProps, nil) (defaults to: nil) —

    Resource properties.



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

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CodeBuild::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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY29kZWJ1aWxkLkNmbkZsZWV0UHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_fleet(resource) ⇒ String

Parameters:

Returns:

  • (String) 


83
84
85
86
 
# File 'code_build/cfn_fleet.rb', line 83

def self.arn_for_fleet(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19jb2RlYnVpbGQuSUZsZWV0UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codebuild.CfnFleet", "arnForFleet", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


190
191
192
 
# File 'code_build/cfn_fleet.rb', line 190

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

.is_cfn_fleet(x) ⇒ Boolean

Checks whether the given object is a CfnFleet.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


92
93
94
95
 
# File 'code_build/cfn_fleet.rb', line 92

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_codebuild.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
 
# File 'code_build/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_arn => { kind: :property, name: "attrArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :fleet_ref => { kind: :property, name: "fleetRef", is_optional: false },
    :base_capacity => { kind: :property, name: "baseCapacity", is_optional: true },
    :compute_configuration => { kind: :property, name: "computeConfiguration", is_optional: true },
    :compute_type => { kind: :property, name: "computeType", is_optional: true },
    :environment_type => { kind: :property, name: "environmentType", is_optional: true },
    :fleet_proxy_configuration => { kind: :property, name: "fleetProxyConfiguration", is_optional: true },
    :fleet_service_role => { kind: :property, name: "fleetServiceRole", is_optional: true },
    :fleet_vpc_config => { kind: :property, name: "fleetVpcConfig", is_optional: true },
    :image_id => { kind: :property, name: "imageId", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :overflow_behavior => { kind: :property, name: "overflowBehavior", is_optional: true },
    :scaling_configuration => { kind: :property, name: "scalingConfiguration", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



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

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:



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

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:



424
425
426
427
 
# File 'code_build/cfn_fleet.rb', line 424

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:



435
436
437
438
439
 
# File 'code_build/cfn_fleet.rb', line 435

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.


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

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.



502
503
504
505
 
# File 'code_build/cfn_fleet.rb', line 502

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.



514
515
516
517
518
 
# File 'code_build/cfn_fleet.rb', line 514

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:



527
528
529
530
 
# File 'code_build/cfn_fleet.rb', line 527

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:



549
550
551
552
553
554
 
# File 'code_build/cfn_fleet.rb', line 549

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_arn ⇒ String

The ARN of the compute fleet.

Returns:

  • (String) 


197
198
199
 
# File 'code_build/cfn_fleet.rb', line 197

def attr_arn()
  jsii_get_property("attrArn")
end

#base_capacity ⇒ Numeric?

The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.

Returns:

  • (Numeric, nil) 


218
219
220
 
# File 'code_build/cfn_fleet.rb', line 218

def base_capacity()
  jsii_get_property("baseCapacity")
end

#base_capacity=(value) ⇒ Object 



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

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



204
205
206
 
# File 'code_build/cfn_fleet.rb', line 204

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



143
144
145
 
# File 'code_build/cfn_fleet.rb', line 143

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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}) 


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


160
161
162
 
# File 'code_build/cfn_fleet.rb', line 160

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#compute_configuration ⇒ AWSCDK::IResolvable, ...

The compute configuration of the compute fleet.

Returns:



230
231
232
 
# File 'code_build/cfn_fleet.rb', line 230

def compute_configuration()
  jsii_get_property("computeConfiguration")
end

#compute_configuration=(value) ⇒ Object 



234
235
236
237
238
 
# File 'code_build/cfn_fleet.rb', line 234

def compute_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnFleet::ComputeConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuRmxlZXQuQ29tcHV0ZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "computeConfiguration") unless value.nil?
  jsii_set_property("computeConfiguration", value)
end

#compute_type ⇒ String?

Information about the compute resources the compute fleet uses.

Available values include:.

Returns:

  • (String, nil) 


245
246
247
 
# File 'code_build/cfn_fleet.rb', line 245

def compute_type()
  jsii_get_property("computeType")
end

#compute_type=(value) ⇒ Object 



249
250
251
252
 
# File 'code_build/cfn_fleet.rb', line 249

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

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



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

def env()
  jsii_get_property("env")
end

#environment_type ⇒ String?

The environment type of the compute fleet.

Returns:

  • (String, nil) 


257
258
259
 
# File 'code_build/cfn_fleet.rb', line 257

def environment_type()
  jsii_get_property("environmentType")
end

#environment_type=(value) ⇒ Object 



261
262
263
264
 
# File 'code_build/cfn_fleet.rb', line 261

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

#fleet_proxy_configuration ⇒ AWSCDK::IResolvable, ...

Information about the proxy configurations that apply network access control to your reserved capacity instances.

Returns:



269
270
271
 
# File 'code_build/cfn_fleet.rb', line 269

def fleet_proxy_configuration()
  jsii_get_property("fleetProxyConfiguration")
end

#fleet_proxy_configuration=(value) ⇒ Object 



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

def fleet_proxy_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnFleet::ProxyConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuRmxlZXQuUHJveHlDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "fleetProxyConfiguration") unless value.nil?
  jsii_set_property("fleetProxyConfiguration", value)
end

#fleet_ref ⇒ AWSCDK::Interfaces::AWSCodebuild::FleetReference

A reference to a Fleet resource.

Returns:



211
212
213
 
# File 'code_build/cfn_fleet.rb', line 211

def fleet_ref()
  jsii_get_property("fleetRef")
end

#fleet_service_role ⇒ String?

The service role associated with the compute fleet.

Returns:

  • (String, nil) 


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

def fleet_service_role()
  jsii_get_property("fleetServiceRole")
end

#fleet_service_role=(value) ⇒ Object 



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

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

#fleet_vpc_config ⇒ AWSCDK::IResolvable, ...

Information about the VPC configuration that AWS CodeBuild accesses.

Returns:



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

def fleet_vpc_config()
  jsii_get_property("fleetVpcConfig")
end

#fleet_vpc_config=(value) ⇒ Object 



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

def fleet_vpc_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnFleet::VPCConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuRmxlZXQuVnBjQ29uZmlnUHJvcGVydHkifV19fQ==")), "fleetVpcConfig") unless value.nil?
  jsii_set_property("fleetVpcConfig", 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:



571
572
573
574
575
 
# File 'code_build/cfn_fleet.rb', line 571

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:



582
583
584
585
 
# File 'code_build/cfn_fleet.rb', line 582

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

#image_id ⇒ String?

The Amazon Machine Image (AMI) of the compute fleet.

Returns:

  • (String, nil) 


307
308
309
 
# File 'code_build/cfn_fleet.rb', line 307

def image_id()
  jsii_get_property("imageId")
end

#image_id=(value) ⇒ Object 



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

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



652
653
654
655
 
# File 'code_build/cfn_fleet.rb', line 652

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


117
118
119
 
# File 'code_build/cfn_fleet.rb', line 117

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String?

The name of the compute fleet.

Returns:

  • (String, nil) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


100
101
102
 
# File 'code_build/cfn_fleet.rb', line 100

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:



593
594
595
 
# File 'code_build/cfn_fleet.rb', line 593

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:



600
601
602
 
# File 'code_build/cfn_fleet.rb', line 600

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

#overflow_behavior ⇒ String?

The compute fleet overflow behavior.

Returns:

  • (String, nil) 


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

def overflow_behavior()
  jsii_get_property("overflowBehavior")
end

#overflow_behavior=(value) ⇒ Object 



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

def overflow_behavior=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "overflowBehavior") unless value.nil?
  jsii_set_property("overflowBehavior", value)
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.



393
394
395
396
 
# File 'code_build/cfn_fleet.rb', line 393

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

#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) 


136
137
138
 
# File 'code_build/cfn_fleet.rb', line 136

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:



611
612
613
614
 
# File 'code_build/cfn_fleet.rb', line 611

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}) 


618
619
620
621
 
# File 'code_build/cfn_fleet.rb', line 618

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:



628
629
630
631
632
 
# File 'code_build/cfn_fleet.rb', line 628

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

#scaling_configuration ⇒ AWSCDK::IResolvable, ...

The scaling configuration of the compute fleet.

Returns:



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

def scaling_configuration()
  jsii_get_property("scalingConfiguration")
end

#scaling_configuration=(value) ⇒ Object 



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

def scaling_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::CodeBuild::CfnFleet::ScalingConfigurationInputProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19jb2RlYnVpbGQuQ2ZuRmxlZXQuU2NhbGluZ0NvbmZpZ3VyYXRpb25JbnB1dFByb3BlcnR5In1dfX0=")), "scalingConfiguration") unless value.nil?
  jsii_set_property("scalingConfiguration", 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.



637
638
639
 
# File 'code_build/cfn_fleet.rb', line 637

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:



126
127
128
 
# File 'code_build/cfn_fleet.rb', line 126

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A list of tag key and value pairs associated with this compute fleet.

Returns:



356
357
358
 
# File 'code_build/cfn_fleet.rb', line 356

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



360
361
362
363
364
 
# File 'code_build/cfn_fleet.rb', line 360

def tags=(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=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



369
370
371
 
# File 'code_build/cfn_fleet.rb', line 369

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}) 


173
174
175
 
# File 'code_build/cfn_fleet.rb', line 173

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}) 


183
184
185
 
# File 'code_build/cfn_fleet.rb', line 183

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


643
644
645
646
 
# File 'code_build/cfn_fleet.rb', line 643

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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) 


382
383
384
385
386
387
 
# File 'code_build/cfn_fleet.rb', line 382

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