Show / Hide Table of Contents

Class CfnFleet

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

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnFleet
Implements
IInspectable
IFleetRef
IConstruct
IDependable
IEnvironmentAware
ITaggableV2
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.AddResourceDependency(CfnResource, string)
CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.CfnPropertyName(string)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.RemoveResourceDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.Env
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.With(params IMixin[])
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.CodeBuild
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFleet : CfnResource, IInspectable, IFleetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Syntax (vb)
Public Class CfnFleet Inherits CfnResource Implements IInspectable, IFleetRef, IConstruct, IDependable, IEnvironmentAware, ITaggableV2
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CodeBuild;

             var cfnFleet = new CfnFleet(this, "MyCfnFleet", new CfnFleetProps {
                 BaseCapacity = 123,
                 ComputeConfiguration = new ComputeConfigurationProperty {
                     Disk = 123,
                     InstanceType = "instanceType",
                     MachineType = "machineType",
                     Memory = 123,
                     VCpu = 123
                 },
                 ComputeType = "computeType",
                 EnvironmentType = "environmentType",
                 FleetProxyConfiguration = new ProxyConfigurationProperty {
                     DefaultBehavior = "defaultBehavior",
                     OrderedProxyRules = new [] { new FleetProxyRuleProperty {
                         Effect = "effect",
                         Entities = new [] { "entities" },
                         Type = "type"
                     } }
                 },
                 FleetServiceRole = "fleetServiceRole",
                 FleetVpcConfig = new VpcConfigProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     Subnets = new [] { "subnets" },
                     VpcId = "vpcId"
                 },
                 ImageId = "imageId",
                 Name = "name",
                 OverflowBehavior = "overflowBehavior",
                 ScalingConfiguration = new ScalingConfigurationInputProperty {
                     MaxCapacity = 123,
                     ScalingType = "scalingType",
                     TargetTrackingScalingConfigs = new [] { new TargetTrackingScalingConfigurationProperty {
                         MetricType = "metricType",
                         TargetValue = 123
                     } }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Synopsis

Constructors

CfnFleet(Construct, string, ICfnFleetProps?)

Create a new AWS::CodeBuild::Fleet.

Properties

AttrArn

The ARN of the compute fleet.

BaseCapacity

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

CdkTagManager

Tag Manager which manages the tags for this resource.

CfnProperties

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

CfnPropertyNames

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

ComputeConfiguration

The compute configuration of the compute fleet.

ComputeType

Information about the compute resources the compute fleet uses.

EnvironmentType

The environment type of the compute fleet.

FleetProxyConfiguration

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

FleetRef

A reference to a Fleet resource.

FleetServiceRole

The service role associated with the compute fleet.

FleetVpcConfig

Information about the VPC configuration that AWS CodeBuild accesses.

ImageId

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

Name

The name of the compute fleet.

OverflowBehavior

The compute fleet overflow behavior.

ScalingConfiguration

The scaling configuration of the compute fleet.

Tags

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

Methods

ArnForFleet(IFleetRef)

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

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

IsCfnFleet(object)

Checks whether the given object is a CfnFleet.

RenderProperties(IDictionary<string, object>)

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

Constructors

CfnFleet(Construct, string, ICfnFleetProps?)

Create a new AWS::CodeBuild::Fleet.

public CfnFleet(Construct scope, string id, ICfnFleetProps? props = null)
Parameters
scope Construct

Scope in which this resource is defined.

id string

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

props ICfnFleetProps

Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

Properties

AttrArn

The ARN of the compute fleet.

public virtual string AttrArn { get; }
Property Value

string

Remarks

CloudformationAttribute: Arn

BaseCapacity

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

public virtual double? BaseCapacity { get; set; }
Property Value

double?

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

CdkTagManager

Tag Manager which manages the tags for this resource.

public virtual TagManager CdkTagManager { get; }
Property Value

TagManager

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

CfnProperties

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

protected override IDictionary<string, object> CfnProperties { get; }
Property Value

IDictionary<string, object>

Overrides
CfnResource.CfnProperties
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

CfnPropertyNames

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

protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value

IDictionary<string, string>

Overrides
CfnResource.CfnPropertyNames
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

ComputeConfiguration

The compute configuration of the compute fleet.

public virtual object? ComputeConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnFleet.IComputeConfigurationProperty

ComputeType

Information about the compute resources the compute fleet uses.

public virtual string? ComputeType { get; set; }
Property Value

string

Remarks

Available values include:.

EnvironmentType

The environment type of the compute fleet.

public virtual string? EnvironmentType { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

FleetProxyConfiguration

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

public virtual object? FleetProxyConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnFleet.IProxyConfigurationProperty

FleetRef

A reference to a Fleet resource.

public virtual IFleetReference FleetRef { get; }
Property Value

IFleetReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

FleetServiceRole

The service role associated with the compute fleet.

public virtual string? FleetServiceRole { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

FleetVpcConfig

Information about the VPC configuration that AWS CodeBuild accesses.

public virtual object? FleetVpcConfig { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnFleet.IVpcConfigProperty

ImageId

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

public virtual string? ImageId { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

Name

The name of the compute fleet.

public virtual string? Name { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

OverflowBehavior

The compute fleet overflow behavior.

public virtual string? OverflowBehavior { get; set; }
Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

ScalingConfiguration

The scaling configuration of the compute fleet.

public virtual object? ScalingConfiguration { get; set; }
Property Value

object

Remarks

Type union: either IResolvable or CfnFleet.IScalingConfigurationInputProperty

Tags

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

public virtual ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

Methods

ArnForFleet(IFleetRef)

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

public static string ArnForFleet(IFleetRef resource)
Parameters
resource IFleetRef
Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.CodeBuild;

             var cfnFleet = new CfnFleet(this, "MyCfnFleet", new CfnFleetProps {
                 BaseCapacity = 123,
                 ComputeConfiguration = new ComputeConfigurationProperty {
                     Disk = 123,
                     InstanceType = "instanceType",
                     MachineType = "machineType",
                     Memory = 123,
                     VCpu = 123
                 },
                 ComputeType = "computeType",
                 EnvironmentType = "environmentType",
                 FleetProxyConfiguration = new ProxyConfigurationProperty {
                     DefaultBehavior = "defaultBehavior",
                     OrderedProxyRules = new [] { new FleetProxyRuleProperty {
                         Effect = "effect",
                         Entities = new [] { "entities" },
                         Type = "type"
                     } }
                 },
                 FleetServiceRole = "fleetServiceRole",
                 FleetVpcConfig = new VpcConfigProperty {
                     SecurityGroupIds = new [] { "securityGroupIds" },
                     Subnets = new [] { "subnets" },
                     VpcId = "vpcId"
                 },
                 ImageId = "imageId",
                 Name = "name",
                 OverflowBehavior = "overflowBehavior",
                 ScalingConfiguration = new ScalingConfigurationInputProperty {
                     MaxCapacity = 123,
                     ScalingType = "scalingType",
                     TargetTrackingScalingConfigs = new [] { new TargetTrackingScalingConfigurationProperty {
                         MetricType = "metricType",
                         TargetValue = 123
                     } }
                 },
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             });

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)
Parameters
inspector TreeInspector

tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

IsCfnFleet(object)

Checks whether the given object is a CfnFleet.

public static bool IsCfnFleet(object x)
Parameters
x object
Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

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

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
props IDictionary<string, object>
Returns

IDictionary<string, object>

Overrides
CfnResource.RenderProperties(IDictionary<string, object>)
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html

CloudformationResource: AWS::CodeBuild::Fleet

ExampleMetadata: fixture=_generated

Implements

IInspectable
IFleetRef
Constructs.IConstruct
Constructs.IDependable
IEnvironmentAware
ITaggableV2
Back to top Generated by DocFX