Class: AWSCDK::CodeBuild::Fleet

Inherits:
Resource
  • Object
show all
Includes:
IFleet
Defined in:
code_build/fleet.rb

Overview

Fleet for a reserved capacity CodeBuild project.

Fleets allow for process builds or tests to run immediately and reduces build durations, by reserving compute resources for your projects.

You will be charged for the resources in the fleet, even if they are idle.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ Fleet

Returns a new instance of Fleet.

Parameters:



19
20
21
22
23
24
25
 
# File 'code_build/fleet.rb', line 19

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

Class Method Details

.from_fleet_arn(scope, id, fleet_arn) ⇒ AWSCDK::CodeBuild::IFleet

Creates a Fleet construct that represents an external fleet.

Parameters:

  • scope (Constructs::Construct) —

    The scope creating construct (usually this).

  • id (String) —

    The construct's id.

  • fleet_arn (String) —

    The ARN of the fleet.

Returns:



56
57
58
59
60
61
 
# File 'code_build/fleet.rb', line 56

def self.from_fleet_arn(scope, id, fleet_arn)
  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(fleet_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fleetArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_codebuild.Fleet", "fromFleetArn", [scope, id, fleet_arn])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'code_build/fleet.rb', line 27

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :compute_type => { kind: :property, name: "computeType", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :environment_type => { kind: :property, name: "environmentType", is_optional: false },
    :fleet_arn => { kind: :property, name: "fleetArn", is_optional: false },
    :fleet_name => { kind: :property, name: "fleetName", is_optional: false },
    :fleet_ref => { kind: :property, name: "fleetRef", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", 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 },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


109
110
111
 
# File 'code_build/fleet.rb', line 109

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

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



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

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) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



213
214
215
216
 
# File 'code_build/fleet.rb', line 213

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#compute_type ⇒ AWSCDK::CodeBuild::FleetComputeType

The compute type of the fleet.

Returns:

See Also:



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

def compute_type()
  jsii_get_property("computeType")
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this Fleet's security group(s) in the configured VPC.

Returns:



124
125
126
 
# File 'code_build/fleet.rb', line 124

def connections()
  jsii_get_property("connections")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



81
82
83
 
# File 'code_build/fleet.rb', line 81

def env()
  jsii_get_property("env")
end

#environment_type ⇒ AWSCDK::CodeBuild::EnvironmentType

The build environment (operating system/architecture/accelerator) type made available to projects using this fleet.

Returns:



131
132
133
 
# File 'code_build/fleet.rb', line 131

def environment_type()
  jsii_get_property("environmentType")
end

#fleet_arn ⇒ String

The ARN of the fleet.

Returns:

  • (String) 


138
139
140
 
# File 'code_build/fleet.rb', line 138

def fleet_arn()
  jsii_get_property("fleetArn")
end

#fleet_name ⇒ String

The name of the fleet.

Returns:

  • (String) 


145
146
147
 
# File 'code_build/fleet.rb', line 145

def fleet_name()
  jsii_get_property("fleetName")
end

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

A reference to a Fleet resource.

Returns:



152
153
154
 
# File 'code_build/fleet.rb', line 152

def fleet_ref()
  jsii_get_property("fleetRef")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


219
220
221
 
# File 'code_build/fleet.rb', line 219

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


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

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


248
249
250
251
 
# File 'code_build/fleet.rb', line 248

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The grant principal for this Fleet's service role.

Returns:



159
160
161
 
# File 'code_build/fleet.rb', line 159

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


66
67
68
 
# File 'code_build/fleet.rb', line 66

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


95
96
97
 
# File 'code_build/fleet.rb', line 95

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



102
103
104
 
# File 'code_build/fleet.rb', line 102

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


166
167
168
 
# File 'code_build/fleet.rb', line 166

def to_string()
  jsii_call_method("toString", [])
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) 


179
180
181
182
183
184
 
# File 'code_build/fleet.rb', line 179

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