CfnFleetPropsMixin

class aws_cdk.mixins_preview.aws_codebuild.mixins.CfnFleetPropsMixin(props, *, strategy=None)

Bases: Mixin

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

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-fleet.html
CloudformationResource:: AWS::CodeBuild::Fleet
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_codebuild import mixins as codebuild_mixins

cfn_fleet_props_mixin = codebuild_mixins.CfnFleetPropsMixin(codebuild_mixins.CfnFleetMixinProps(
    base_capacity=123,
    compute_configuration=codebuild_mixins.CfnFleetPropsMixin.ComputeConfigurationProperty(
        disk=123,
        instance_type="instanceType",
        machine_type="machineType",
        memory=123,
        v_cpu=123
    ),
    compute_type="computeType",
    environment_type="environmentType",
    fleet_proxy_configuration=codebuild_mixins.CfnFleetPropsMixin.ProxyConfigurationProperty(
        default_behavior="defaultBehavior",
        ordered_proxy_rules=[codebuild_mixins.CfnFleetPropsMixin.FleetProxyRuleProperty(
            effect="effect",
            entities=["entities"],
            type="type"
        )]
    ),
    fleet_service_role="fleetServiceRole",
    fleet_vpc_config=codebuild_mixins.CfnFleetPropsMixin.VpcConfigProperty(
        security_group_ids=["securityGroupIds"],
        subnets=["subnets"],
        vpc_id="vpcId"
    ),
    image_id="imageId",
    name="name",
    overflow_behavior="overflowBehavior",
    scaling_configuration=codebuild_mixins.CfnFleetPropsMixin.ScalingConfigurationInputProperty(
        max_capacity=123,
        scaling_type="scalingType",
        target_tracking_scaling_configs=[codebuild_mixins.CfnFleetPropsMixin.TargetTrackingScalingConfigurationProperty(
            metric_type="metricType",
            target_value=123
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::CodeBuild::Fleet.

Parameters:

props (Union[CfnFleetMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['baseCapacity', 'computeConfiguration', 'computeType', 'environmentType', 'fleetProxyConfiguration', 'fleetServiceRole', 'fleetVpcConfig', 'imageId', 'name', 'overflowBehavior', 'scalingConfiguration', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

ComputeConfigurationProperty

class CfnFleetPropsMixin.ComputeConfigurationProperty(*, disk=None, instance_type=None, machine_type=None, memory=None, v_cpu=None)

Bases: object

Contains compute attributes.

These attributes only need be specified when your project’s or fleet’s computeType is set to ATTRIBUTE_BASED_COMPUTE or CUSTOM_INSTANCE_TYPE .

Parameters:

disk (Union[int, float, None]) – The amount of disk space of the instance type included in your fleet.
instance_type (Optional[str]) – The EC2 instance type to be launched in your fleet.
machine_type (Optional[str]) – The machine type of the instance type included in your fleet.
memory (Union[int, float, None]) – The amount of memory of the instance type included in your fleet.
v_cpu (Union[int, float, None]) – The number of vCPUs of the instance type included in your fleet.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-computeconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codebuild import mixins as codebuild_mixins

compute_configuration_property = codebuild_mixins.CfnFleetPropsMixin.ComputeConfigurationProperty(
    disk=123,
    instance_type="instanceType",
    machine_type="machineType",
    memory=123,
    v_cpu=123
)

Attributes

disk

The amount of disk space of the instance type included in your fleet.

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

instance_type

The EC2 instance type to be launched in your fleet.

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

machine_type

The machine type of the instance type included in your fleet.

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

memory

The amount of memory of the instance type included in your fleet.

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

v_cpu

The number of vCPUs of the instance type included in your fleet.

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

FleetProxyRuleProperty

class CfnFleetPropsMixin.FleetProxyRuleProperty(*, effect=None, entities=None, type=None)

Bases: object

Information about the proxy rule for your reserved capacity instances.

Parameters:

effect (Optional[str]) – The behavior of the proxy rule.
entities (Optional[Sequence[str]]) – The destination of the proxy rule.
type (Optional[str]) – The type of proxy rule.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-fleetproxyrule.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codebuild import mixins as codebuild_mixins

fleet_proxy_rule_property = codebuild_mixins.CfnFleetPropsMixin.FleetProxyRuleProperty(
    effect="effect",
    entities=["entities"],
    type="type"
)

Attributes

effect

The behavior of the proxy rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-fleetproxyrule.html#cfn-codebuild-fleet-fleetproxyrule-effect

entities

The destination of the proxy rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-fleetproxyrule.html#cfn-codebuild-fleet-fleetproxyrule-entities

type

The type of proxy rule.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-fleetproxyrule.html#cfn-codebuild-fleet-fleetproxyrule-type

ProxyConfigurationProperty

class CfnFleetPropsMixin.ProxyConfigurationProperty(*, default_behavior=None, ordered_proxy_rules=None)

Bases: object

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

Parameters:

default_behavior (Optional[str]) – The default behavior of outgoing traffic.
ordered_proxy_rules (Union[IResolvable, Sequence[Union[IResolvable, FleetProxyRuleProperty, Dict[str, Any]]], None]) – An array of FleetProxyRule objects that represent the specified destination domains or IPs to allow or deny network access control to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-proxyconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codebuild import mixins as codebuild_mixins

proxy_configuration_property = codebuild_mixins.CfnFleetPropsMixin.ProxyConfigurationProperty(
    default_behavior="defaultBehavior",
    ordered_proxy_rules=[codebuild_mixins.CfnFleetPropsMixin.FleetProxyRuleProperty(
        effect="effect",
        entities=["entities"],
        type="type"
    )]
)

Attributes

default_behavior

The default behavior of outgoing traffic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-proxyconfiguration.html#cfn-codebuild-fleet-proxyconfiguration-defaultbehavior

ordered_proxy_rules

An array of FleetProxyRule objects that represent the specified destination domains or IPs to allow or deny network access control to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-proxyconfiguration.html#cfn-codebuild-fleet-proxyconfiguration-orderedproxyrules

ScalingConfigurationInputProperty

class CfnFleetPropsMixin.ScalingConfigurationInputProperty(*, max_capacity=None, scaling_type=None, target_tracking_scaling_configs=None)

Bases: object

The scaling configuration input of a compute fleet.

Parameters:

max_capacity (Union[int, float, None]) – The maximum number of instances in the ﬂeet when auto-scaling.
scaling_type (Optional[str]) – The scaling type for a compute fleet.
target_tracking_scaling_configs (Union[IResolvable, Sequence[Union[IResolvable, TargetTrackingScalingConfigurationProperty, Dict[str, Any]]], None]) – A list of TargetTrackingScalingConfiguration objects.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-scalingconfigurationinput.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codebuild import mixins as codebuild_mixins

scaling_configuration_input_property = codebuild_mixins.CfnFleetPropsMixin.ScalingConfigurationInputProperty(
    max_capacity=123,
    scaling_type="scalingType",
    target_tracking_scaling_configs=[codebuild_mixins.CfnFleetPropsMixin.TargetTrackingScalingConfigurationProperty(
        metric_type="metricType",
        target_value=123
    )]
)

Attributes

max_capacity

The maximum number of instances in the ﬂeet when auto-scaling.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-scalingconfigurationinput.html#cfn-codebuild-fleet-scalingconfigurationinput-maxcapacity

scaling_type

The scaling type for a compute fleet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-scalingconfigurationinput.html#cfn-codebuild-fleet-scalingconfigurationinput-scalingtype

target_tracking_scaling_configs

A list of TargetTrackingScalingConfiguration objects.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-scalingconfigurationinput.html#cfn-codebuild-fleet-scalingconfigurationinput-targettrackingscalingconfigs

TargetTrackingScalingConfigurationProperty

class CfnFleetPropsMixin.TargetTrackingScalingConfigurationProperty(*, metric_type=None, target_value=None)

Bases: object

Defines when a new instance is auto-scaled into the compute fleet.

Parameters:

metric_type (Optional[str]) – The metric type to determine auto-scaling.
target_value (Union[int, float, None]) – The value of metricType when to start scaling.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-targettrackingscalingconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codebuild import mixins as codebuild_mixins

target_tracking_scaling_configuration_property = codebuild_mixins.CfnFleetPropsMixin.TargetTrackingScalingConfigurationProperty(
    metric_type="metricType",
    target_value=123
)

Attributes

metric_type

The metric type to determine auto-scaling.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-targettrackingscalingconfiguration.html#cfn-codebuild-fleet-targettrackingscalingconfiguration-metrictype

target_value

The value of metricType when to start scaling.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-targettrackingscalingconfiguration.html#cfn-codebuild-fleet-targettrackingscalingconfiguration-targetvalue

VpcConfigProperty

class CfnFleetPropsMixin.VpcConfigProperty(*, security_group_ids=None, subnets=None, vpc_id=None)

Bases: object

Information about the VPC configuration that AWS CodeBuild accesses.

Parameters:

security_group_ids (Optional[Sequence[str]]) – A list of one or more security groups IDs in your Amazon VPC.
subnets (Optional[Sequence[str]]) – A list of one or more subnet IDs in your Amazon VPC.
vpc_id (Optional[str]) – The ID of the Amazon VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-vpcconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_codebuild import mixins as codebuild_mixins

vpc_config_property = codebuild_mixins.CfnFleetPropsMixin.VpcConfigProperty(
    security_group_ids=["securityGroupIds"],
    subnets=["subnets"],
    vpc_id="vpcId"
)

Attributes

security_group_ids

A list of one or more security groups IDs in your Amazon VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-vpcconfig.html#cfn-codebuild-fleet-vpcconfig-securitygroupids

subnets

A list of one or more subnet IDs in your Amazon VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-vpcconfig.html#cfn-codebuild-fleet-vpcconfig-subnets

vpc_id

The ID of the Amazon VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-fleet-vpcconfig.html#cfn-codebuild-fleet-vpcconfig-vpcid