Interface ICfnFleetProps

Properties for defining a CfnFleet.

Namespace: Amazon.CDK.AWS.CodeBuild

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface ICfnFleetProps

Syntax (vb)

Public Interface ICfnFleetProps

Remarks

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

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 cfnFleetProps = 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

Properties

BaseCapacity	The initial number of machines allocated to the compute ﬂeet, which deﬁnes the number of builds that can run in parallel.
ComputeConfiguration	The compute configuration of the compute fleet.
ComputeType	Information about the compute resources the compute fleet uses. Available values include:.
EnvironmentType	The environment type of the compute fleet.
FleetProxyConfiguration	Information about the proxy configurations that apply network access control to your reserved capacity instances.
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.

Properties

BaseCapacity

The initial number of machines allocated to the compute ﬂeet, which deﬁnes the number of builds that can run in parallel.

double? BaseCapacity { get; }

Property Value

double?

Remarks

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

ComputeConfiguration

The compute configuration of the compute fleet.

object? ComputeConfiguration { get; }

Property Value

object

Remarks

This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE .

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

Type union: either IResolvable or CfnFleet.IComputeConfigurationProperty

ComputeType

Information about the compute resources the compute fleet uses. Available values include:.

string? ComputeType { get; }

Property Value

string

Remarks

If you use <code>ATTRIBUTE_BASED_COMPUTE</code> , you must define your attributes by using <code>computeConfiguration</code> . AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.types">Reserved capacity environment types</a> in the <em>AWS CodeBuild User Guide</em> .

If you use BUILD_GENERAL1_SMALL :

If you use BUILD_GENERAL1_LARGE :

For more information, see On-demand environment types in the AWS CodeBuild User Guide.

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

EnvironmentType

The environment type of the compute fleet.

string? EnvironmentType { get; }

Property Value

string

Remarks

For more information, see Build environment compute types in the AWS CodeBuild user guide .

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

FleetProxyConfiguration

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

object? FleetProxyConfiguration { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnFleet.IProxyConfigurationProperty

FleetServiceRole

The service role associated with the compute fleet.

string? FleetServiceRole { get; }

Property Value

string

Remarks

For more information, see Allow a user to add a permission policy for a fleet service role in the AWS CodeBuild User Guide .

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

FleetVpcConfig

Information about the VPC configuration that AWS CodeBuild accesses.

object? FleetVpcConfig { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnFleet.IVpcConfigProperty

ImageId

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

string? ImageId { get; }

Property Value

string

Remarks

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

Name

The name of the compute fleet.

string? Name { get; }

Property Value

string

Remarks

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

OverflowBehavior

The compute fleet overflow behavior.

string? OverflowBehavior { get; }

Property Value

string

Remarks

If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/auth-and-access-control-iam-identity-based-access-control.html#customer-managed-policies-example-create-vpc-network-interface">Example policy statement to allow CodeBuild access to AWS services required to create a VPC network interface</a> .

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

ScalingConfiguration

The scaling configuration of the compute fleet.

object? ScalingConfiguration { get; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnFleet.IScalingConfigurationInputProperty