Module: AWSCDK::CodeBuild::IFleet

Includes:
EC2::IConnectable, IAM::IGrantable, IResource, Interfaces::AWSCodebuild::IFleetRef
Included in:
Fleet
Defined in:
code_build/i_fleet.rb

Overview

Represents a Fleet for a reserved capacity CodeBuild project.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'code_build/i_fleet.rb', line 121

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :fleet_ref => { kind: :property, name: "fleetRef", is_optional: false },
    :compute_type => { kind: :property, name: "computeType", 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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

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



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

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:



65
66
67
 
# File 'code_build/i_fleet.rb', line 65

def compute_type()
  jsii_get_property("computeType")
end

#connections ⇒ AWSCDK::EC2::Connections

The network connections associated with this resource.

Returns:



50
51
52
 
# File 'code_build/i_fleet.rb', line 50

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:



29
30
31
 
# File 'code_build/i_fleet.rb', line 29

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:



72
73
74
 
# File 'code_build/i_fleet.rb', line 72

def environment_type()
  jsii_get_property("environmentType")
end

#fleet_arn ⇒ String

The ARN of the fleet.

Returns:

  • (String) 


79
80
81
 
# File 'code_build/i_fleet.rb', line 79

def fleet_arn()
  jsii_get_property("fleetArn")
end

#fleet_name ⇒ String

The name of the fleet.

Returns:

  • (String) 


86
87
88
 
# File 'code_build/i_fleet.rb', line 86

def fleet_name()
  jsii_get_property("fleetName")
end

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

A reference to a Fleet resource.

Returns:



57
58
59
 
# File 'code_build/i_fleet.rb', line 57

def fleet_ref()
  jsii_get_property("fleetRef")
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



43
44
45
 
# File 'code_build/i_fleet.rb', line 43

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


14
15
16
 
# File 'code_build/i_fleet.rb', line 14

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



36
37
38
 
# File 'code_build/i_fleet.rb', line 36

def stack()
  jsii_get_property("stack")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



97
98
99
100
101
102
 
# File 'code_build/i_fleet.rb', line 97

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