This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS CodeBuild
<a name="AWS_CodeBuild"></a>

**Resource types**
+ [AWS::CodeBuild::Fleet](aws-resource-codebuild-fleet.md)
+ [AWS::CodeBuild::Project](aws-resource-codebuild-project.md)
+ [AWS::CodeBuild::ReportGroup](aws-resource-codebuild-reportgroup.md)
+ [AWS::CodeBuild::SourceCredential](aws-resource-codebuild-sourcecredential.md)

# AWS::CodeBuild::Fleet
<a name="aws-resource-codebuild-fleet"></a>

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

## Syntax
<a name="aws-resource-codebuild-fleet-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-codebuild-fleet-syntax.json"></a>

```
{
  "Type" : "AWS::CodeBuild::Fleet",
  "Properties" : {
      "[BaseCapacity](#cfn-codebuild-fleet-basecapacity)" : Integer,
      "[ComputeConfiguration](#cfn-codebuild-fleet-computeconfiguration)" : ComputeConfiguration,
      "[ComputeType](#cfn-codebuild-fleet-computetype)" : String,
      "[EnvironmentType](#cfn-codebuild-fleet-environmenttype)" : String,
      "[FleetProxyConfiguration](#cfn-codebuild-fleet-fleetproxyconfiguration)" : ProxyConfiguration,
      "[FleetServiceRole](#cfn-codebuild-fleet-fleetservicerole)" : String,
      "[FleetVpcConfig](#cfn-codebuild-fleet-fleetvpcconfig)" : VpcConfig,
      "[ImageId](#cfn-codebuild-fleet-imageid)" : String,
      "[Name](#cfn-codebuild-fleet-name)" : String,
      "[OverflowBehavior](#cfn-codebuild-fleet-overflowbehavior)" : String,
      "[ScalingConfiguration](#cfn-codebuild-fleet-scalingconfiguration)" : ScalingConfigurationInput,
      "[Tags](#cfn-codebuild-fleet-tags)" : [ Tag, ... ]
    }
}
```

### YAML
<a name="aws-resource-codebuild-fleet-syntax.yaml"></a>

```
Type: AWS::CodeBuild::Fleet
Properties:
  [BaseCapacity](#cfn-codebuild-fleet-basecapacity): Integer
  [ComputeConfiguration](#cfn-codebuild-fleet-computeconfiguration): 
    ComputeConfiguration
  [ComputeType](#cfn-codebuild-fleet-computetype): String
  [EnvironmentType](#cfn-codebuild-fleet-environmenttype): String
  [FleetProxyConfiguration](#cfn-codebuild-fleet-fleetproxyconfiguration): 
    ProxyConfiguration
  [FleetServiceRole](#cfn-codebuild-fleet-fleetservicerole): String
  [FleetVpcConfig](#cfn-codebuild-fleet-fleetvpcconfig): 
    VpcConfig
  [ImageId](#cfn-codebuild-fleet-imageid): String
  [Name](#cfn-codebuild-fleet-name): String
  [OverflowBehavior](#cfn-codebuild-fleet-overflowbehavior): String
  [ScalingConfiguration](#cfn-codebuild-fleet-scalingconfiguration): 
    ScalingConfigurationInput
  [Tags](#cfn-codebuild-fleet-tags): 
    - Tag
```

## Properties
<a name="aws-resource-codebuild-fleet-properties"></a>

`BaseCapacity`  <a name="cfn-codebuild-fleet-basecapacity"></a>
The initial number of machines allocated to the compute fleet, which defines the number of builds that can run in parallel.  
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ComputeConfiguration`  <a name="cfn-codebuild-fleet-computeconfiguration"></a>
The compute configuration of the compute fleet. This is only required if `computeType` is set to `ATTRIBUTE_BASED_COMPUTE` or `CUSTOM_INSTANCE_TYPE`.  
*Required*: No  
*Type*: [ComputeConfiguration](aws-properties-codebuild-fleet-computeconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ComputeType`  <a name="cfn-codebuild-fleet-computetype"></a>
Information about the compute resources the compute fleet uses. Available values include:  
+ `ATTRIBUTE_BASED_COMPUTE`: Specify the amount of vCPUs, memory, disk space, and the type of machine.
**Note**  
 If you use `ATTRIBUTE_BASED_COMPUTE`, you must define your attributes by using `computeConfiguration`. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see [Reserved capacity environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.types) in the *AWS CodeBuild User Guide*.
+ `BUILD_GENERAL1_SMALL`: Use up to 4 GiB memory and 2 vCPUs for builds.
+ `BUILD_GENERAL1_MEDIUM`: Use up to 8 GiB memory and 4 vCPUs for builds.
+ `BUILD_GENERAL1_LARGE`: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
+ `BUILD_GENERAL1_XLARGE`: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
+ `BUILD_GENERAL1_2XLARGE`: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
+ `BUILD_LAMBDA_1GB`: Use up to 1 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
+ `BUILD_LAMBDA_2GB`: Use up to 2 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
+ `BUILD_LAMBDA_4GB`: Use up to 4 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
+ `BUILD_LAMBDA_8GB`: Use up to 8 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
+ `BUILD_LAMBDA_10GB`: Use up to 10 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
 If you use `BUILD_GENERAL1_SMALL`:   
+  For environment type `LINUX_CONTAINER`, you can use up to 4 GiB memory and 2 vCPUs for builds. 
+  For environment type `LINUX_GPU_CONTAINER`, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
+  For environment type `ARM_CONTAINER`, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
 If you use `BUILD_GENERAL1_LARGE`:   
+  For environment type `LINUX_CONTAINER`, you can use up to 16 GiB memory and 8 vCPUs for builds. 
+  For environment type `LINUX_GPU_CONTAINER`, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
+  For environment type `ARM_CONTAINER`, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see [On-demand environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types) in the *AWS CodeBuild User Guide.*  
*Required*: No  
*Type*: String  
*Allowed values*: `BUILD_GENERAL1_SMALL | BUILD_GENERAL1_MEDIUM | BUILD_GENERAL1_LARGE | BUILD_GENERAL1_XLARGE | BUILD_GENERAL1_2XLARGE | ATTRIBUTE_BASED_COMPUTE | CUSTOM_INSTANCE_TYPE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnvironmentType`  <a name="cfn-codebuild-fleet-environmenttype"></a>
The environment type of the compute fleet.  
+ The environment type `ARM_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
+ The environment type `ARM_EC2` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
+ The environment type `LINUX_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
+ The environment type `LINUX_EC2` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
+ The environment type `LINUX_GPU_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
+ The environment type `MAC_ARM` is available only in regions US East (Ohio), US East (N. Virginia), US West (Oregon), Europe (Frankfurt), and Asia Pacific (Sydney).
+ The environment type `WINDOWS_EC2` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
+ The environment type `WINDOWS_SERVER_2019_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
+ The environment type `WINDOWS_SERVER_2022_CONTAINER` is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).
For more information, see [Build environment compute types](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild user guide*.  
*Required*: No  
*Type*: String  
*Allowed values*: `WINDOWS_SERVER_2019_CONTAINER | WINDOWS_SERVER_2022_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER | MAC_ARM | LINUX_EC2 | ARM_EC2 | WINDOWS_EC2`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FleetProxyConfiguration`  <a name="cfn-codebuild-fleet-fleetproxyconfiguration"></a>
Information about the proxy configurations that apply network access control to your reserved capacity instances.  
*Required*: No  
*Type*: [ProxyConfiguration](aws-properties-codebuild-fleet-proxyconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FleetServiceRole`  <a name="cfn-codebuild-fleet-fleetservicerole"></a>
The service role associated with the compute fleet. For more information, see [ Allow a user to add a permission policy for a fleet service role](https://docs.aws.amazon.com/codebuild/latest/userguide/auth-and-access-control-iam-identity-based-access-control.html#customer-managed-policies-example-permission-policy-fleet-service-role.html) in the *AWS CodeBuild User Guide*.  
*Required*: No  
*Type*: String  
*Pattern*: `^(?:arn:)[a-zA-Z+-=,._:/@]+$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FleetVpcConfig`  <a name="cfn-codebuild-fleet-fleetvpcconfig"></a>
Information about the VPC configuration that AWS CodeBuild accesses.  
*Required*: No  
*Type*: [VpcConfig](aws-properties-codebuild-fleet-vpcconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ImageId`  <a name="cfn-codebuild-fleet-imageid"></a>
The Amazon Machine Image (AMI) of the compute fleet.  
*Required*: No  
*Type*: String  
*Pattern*: `^((aws/codebuild/([A-Za-z0-9._-]+|ami/[A-Za-z0-9._-]+):[A-Za-z0-9._-]+)|ami-[a-z0-9]{1,1020})$`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-codebuild-fleet-name"></a>
The name of the compute fleet.  
*Required*: No  
*Type*: String  
*Minimum*: `2`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OverflowBehavior`  <a name="cfn-codebuild-fleet-overflowbehavior"></a>
The compute fleet overflow behavior.  
+ For overflow behavior `QUEUE`, your overflow builds need to wait on the existing fleet instance to become available.
+ For overflow behavior `ON_DEMAND`, your overflow builds run on CodeBuild on-demand.
**Note**  
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 [Example policy statement to allow CodeBuild access to AWS services required to create a VPC network interface](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).
*Required*: No  
*Type*: String  
*Allowed values*: `QUEUE | ON_DEMAND`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScalingConfiguration`  <a name="cfn-codebuild-fleet-scalingconfiguration"></a>
The scaling configuration of the compute fleet.  
*Required*: No  
*Type*: [ScalingConfigurationInput](aws-properties-codebuild-fleet-scalingconfigurationinput.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-codebuild-fleet-tags"></a>
A list of tag key and value pairs associated with this compute fleet.  
These tags are available for use by AWS services that support AWS CodeBuild compute fleet tags.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-codebuild-fleet-tag.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-codebuild-fleet-return-values"></a>

### Ref
<a name="aws-resource-codebuild-fleet-return-values-ref"></a>

When you pass the logical ID of this resource to the intrinsic `Ref` function, `Ref` returns the ARN of the AWS CodeBuild compute fleet.

For more information about using the `Ref` function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-codebuild-fleet-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-codebuild-fleet-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the compute fleet.

# AWS::CodeBuild::Fleet ComputeConfiguration
<a name="aws-properties-codebuild-fleet-computeconfiguration"></a>

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

## Syntax
<a name="aws-properties-codebuild-fleet-computeconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-fleet-computeconfiguration-syntax.json"></a>

```
{
  "[disk](#cfn-codebuild-fleet-computeconfiguration-disk)" : Integer,
  "[instanceType](#cfn-codebuild-fleet-computeconfiguration-instancetype)" : String,
  "[machineType](#cfn-codebuild-fleet-computeconfiguration-machinetype)" : String,
  "[memory](#cfn-codebuild-fleet-computeconfiguration-memory)" : Integer,
  "[vCpu](#cfn-codebuild-fleet-computeconfiguration-vcpu)" : Integer
}
```

### YAML
<a name="aws-properties-codebuild-fleet-computeconfiguration-syntax.yaml"></a>

```
  [disk](#cfn-codebuild-fleet-computeconfiguration-disk): Integer
  [instanceType](#cfn-codebuild-fleet-computeconfiguration-instancetype): String
  [machineType](#cfn-codebuild-fleet-computeconfiguration-machinetype): String
  [memory](#cfn-codebuild-fleet-computeconfiguration-memory): Integer
  [vCpu](#cfn-codebuild-fleet-computeconfiguration-vcpu): Integer
```

## Properties
<a name="aws-properties-codebuild-fleet-computeconfiguration-properties"></a>

`disk`  <a name="cfn-codebuild-fleet-computeconfiguration-disk"></a>
The amount of disk space of the instance type included in your fleet.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`instanceType`  <a name="cfn-codebuild-fleet-computeconfiguration-instancetype"></a>
The EC2 instance type to be launched in your fleet.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`machineType`  <a name="cfn-codebuild-fleet-computeconfiguration-machinetype"></a>
The machine type of the instance type included in your fleet.  
*Required*: No  
*Type*: String  
*Allowed values*: `GENERAL | NVME`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`memory`  <a name="cfn-codebuild-fleet-computeconfiguration-memory"></a>
The amount of memory of the instance type included in your fleet.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`vCpu`  <a name="cfn-codebuild-fleet-computeconfiguration-vcpu"></a>
The number of vCPUs of the instance type included in your fleet.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Fleet FleetProxyRule
<a name="aws-properties-codebuild-fleet-fleetproxyrule"></a>

Information about the proxy rule for your reserved capacity instances.

## Syntax
<a name="aws-properties-codebuild-fleet-fleetproxyrule-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-fleet-fleetproxyrule-syntax.json"></a>

```
{
  "[Effect](#cfn-codebuild-fleet-fleetproxyrule-effect)" : String,
  "[Entities](#cfn-codebuild-fleet-fleetproxyrule-entities)" : [ String, ... ],
  "[Type](#cfn-codebuild-fleet-fleetproxyrule-type)" : String
}
```

### YAML
<a name="aws-properties-codebuild-fleet-fleetproxyrule-syntax.yaml"></a>

```
  [Effect](#cfn-codebuild-fleet-fleetproxyrule-effect): String
  [Entities](#cfn-codebuild-fleet-fleetproxyrule-entities): 
    - String
  [Type](#cfn-codebuild-fleet-fleetproxyrule-type): String
```

## Properties
<a name="aws-properties-codebuild-fleet-fleetproxyrule-properties"></a>

`Effect`  <a name="cfn-codebuild-fleet-fleetproxyrule-effect"></a>
The behavior of the proxy rule.  
*Required*: No  
*Type*: String  
*Allowed values*: `ALLOW | DENY`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Entities`  <a name="cfn-codebuild-fleet-fleetproxyrule-entities"></a>
The destination of the proxy rule.  
*Required*: No  
*Type*: Array of String  
*Minimum*: `1`  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-fleet-fleetproxyrule-type"></a>
The type of proxy rule.  
*Required*: No  
*Type*: String  
*Allowed values*: `DOMAIN | IP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Fleet ProxyConfiguration
<a name="aws-properties-codebuild-fleet-proxyconfiguration"></a>

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

## Syntax
<a name="aws-properties-codebuild-fleet-proxyconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-fleet-proxyconfiguration-syntax.json"></a>

```
{
  "[DefaultBehavior](#cfn-codebuild-fleet-proxyconfiguration-defaultbehavior)" : String,
  "[OrderedProxyRules](#cfn-codebuild-fleet-proxyconfiguration-orderedproxyrules)" : [ FleetProxyRule, ... ]
}
```

### YAML
<a name="aws-properties-codebuild-fleet-proxyconfiguration-syntax.yaml"></a>

```
  [DefaultBehavior](#cfn-codebuild-fleet-proxyconfiguration-defaultbehavior): String
  [OrderedProxyRules](#cfn-codebuild-fleet-proxyconfiguration-orderedproxyrules): 
    - FleetProxyRule
```

## Properties
<a name="aws-properties-codebuild-fleet-proxyconfiguration-properties"></a>

`DefaultBehavior`  <a name="cfn-codebuild-fleet-proxyconfiguration-defaultbehavior"></a>
The default behavior of outgoing traffic.  
*Required*: No  
*Type*: String  
*Allowed values*: `ALLOW_ALL | DENY_ALL`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OrderedProxyRules`  <a name="cfn-codebuild-fleet-proxyconfiguration-orderedproxyrules"></a>
An array of `FleetProxyRule` objects that represent the specified destination domains or IPs to allow or deny network access control to.  
*Required*: No  
*Type*: Array of [FleetProxyRule](aws-properties-codebuild-fleet-fleetproxyrule.md)  
*Maximum*: `100`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Fleet ScalingConfigurationInput
<a name="aws-properties-codebuild-fleet-scalingconfigurationinput"></a>

The scaling configuration input of a compute fleet.

## Syntax
<a name="aws-properties-codebuild-fleet-scalingconfigurationinput-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-fleet-scalingconfigurationinput-syntax.json"></a>

```
{
  "[MaxCapacity](#cfn-codebuild-fleet-scalingconfigurationinput-maxcapacity)" : Integer,
  "[ScalingType](#cfn-codebuild-fleet-scalingconfigurationinput-scalingtype)" : String,
  "[TargetTrackingScalingConfigs](#cfn-codebuild-fleet-scalingconfigurationinput-targettrackingscalingconfigs)" : [ TargetTrackingScalingConfiguration, ... ]
}
```

### YAML
<a name="aws-properties-codebuild-fleet-scalingconfigurationinput-syntax.yaml"></a>

```
  [MaxCapacity](#cfn-codebuild-fleet-scalingconfigurationinput-maxcapacity): Integer
  [ScalingType](#cfn-codebuild-fleet-scalingconfigurationinput-scalingtype): String
  [TargetTrackingScalingConfigs](#cfn-codebuild-fleet-scalingconfigurationinput-targettrackingscalingconfigs): 
    - TargetTrackingScalingConfiguration
```

## Properties
<a name="aws-properties-codebuild-fleet-scalingconfigurationinput-properties"></a>

`MaxCapacity`  <a name="cfn-codebuild-fleet-scalingconfigurationinput-maxcapacity"></a>
The maximum number of instances in the fleet when auto-scaling.  
*Required*: No  
*Type*: Integer  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScalingType`  <a name="cfn-codebuild-fleet-scalingconfigurationinput-scalingtype"></a>
The scaling type for a compute fleet.  
*Required*: No  
*Type*: String  
*Allowed values*: `TARGET_TRACKING_SCALING`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetTrackingScalingConfigs`  <a name="cfn-codebuild-fleet-scalingconfigurationinput-targettrackingscalingconfigs"></a>
A list of `TargetTrackingScalingConfiguration` objects.  
*Required*: No  
*Type*: Array of [TargetTrackingScalingConfiguration](aws-properties-codebuild-fleet-targettrackingscalingconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Fleet Tag
<a name="aws-properties-codebuild-fleet-tag"></a>

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.

## Syntax
<a name="aws-properties-codebuild-fleet-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-fleet-tag-syntax.json"></a>

```
{
  "[Key](#cfn-codebuild-fleet-tag-key)" : String,
  "[Value](#cfn-codebuild-fleet-tag-value)" : String
}
```

### YAML
<a name="aws-properties-codebuild-fleet-tag-syntax.yaml"></a>

```
  [Key](#cfn-codebuild-fleet-tag-key): String
  [Value](#cfn-codebuild-fleet-tag-value): String
```

## Properties
<a name="aws-properties-codebuild-fleet-tag-properties"></a>

`Key`  <a name="cfn-codebuild-fleet-tag-key"></a>
The tag's key.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^(?!aws:)[a-zA-Z+-=._:/]+$`  
*Minimum*: `1`  
*Maximum*: `128`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-codebuild-fleet-tag-value"></a>
The tag's value.  
*Required*: Yes  
*Type*: String  
*Pattern*: `[a-zA-Z+-=._:/]+$`  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Fleet TargetTrackingScalingConfiguration
<a name="aws-properties-codebuild-fleet-targettrackingscalingconfiguration"></a>

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

## Syntax
<a name="aws-properties-codebuild-fleet-targettrackingscalingconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-fleet-targettrackingscalingconfiguration-syntax.json"></a>

```
{
  "[MetricType](#cfn-codebuild-fleet-targettrackingscalingconfiguration-metrictype)" : String,
  "[TargetValue](#cfn-codebuild-fleet-targettrackingscalingconfiguration-targetvalue)" : Number
}
```

### YAML
<a name="aws-properties-codebuild-fleet-targettrackingscalingconfiguration-syntax.yaml"></a>

```
  [MetricType](#cfn-codebuild-fleet-targettrackingscalingconfiguration-metrictype): String
  [TargetValue](#cfn-codebuild-fleet-targettrackingscalingconfiguration-targetvalue): Number
```

## Properties
<a name="aws-properties-codebuild-fleet-targettrackingscalingconfiguration-properties"></a>

`MetricType`  <a name="cfn-codebuild-fleet-targettrackingscalingconfiguration-metrictype"></a>
The metric type to determine auto-scaling.  
*Required*: No  
*Type*: String  
*Allowed values*: `FLEET_UTILIZATION_RATE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetValue`  <a name="cfn-codebuild-fleet-targettrackingscalingconfiguration-targetvalue"></a>
The value of `metricType` when to start scaling.  
*Required*: No  
*Type*: Number  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Fleet VpcConfig
<a name="aws-properties-codebuild-fleet-vpcconfig"></a>

Information about the VPC configuration that AWS CodeBuild accesses.

## Syntax
<a name="aws-properties-codebuild-fleet-vpcconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-fleet-vpcconfig-syntax.json"></a>

```
{
  "[SecurityGroupIds](#cfn-codebuild-fleet-vpcconfig-securitygroupids)" : [ String, ... ],
  "[Subnets](#cfn-codebuild-fleet-vpcconfig-subnets)" : [ String, ... ],
  "[VpcId](#cfn-codebuild-fleet-vpcconfig-vpcid)" : String
}
```

### YAML
<a name="aws-properties-codebuild-fleet-vpcconfig-syntax.yaml"></a>

```
  [SecurityGroupIds](#cfn-codebuild-fleet-vpcconfig-securitygroupids): 
    - String
  [Subnets](#cfn-codebuild-fleet-vpcconfig-subnets): 
    - String
  [VpcId](#cfn-codebuild-fleet-vpcconfig-vpcid): String
```

## Properties
<a name="aws-properties-codebuild-fleet-vpcconfig-properties"></a>

`SecurityGroupIds`  <a name="cfn-codebuild-fleet-vpcconfig-securitygroupids"></a>
A list of one or more security groups IDs in your Amazon VPC.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Subnets`  <a name="cfn-codebuild-fleet-vpcconfig-subnets"></a>
A list of one or more subnet IDs in your Amazon VPC.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `16`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcId`  <a name="cfn-codebuild-fleet-vpcconfig-vpcid"></a>
The ID of the Amazon VPC.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project
<a name="aws-resource-codebuild-project"></a>

The `AWS::CodeBuild::Project` resource configures how AWS CodeBuild builds your source code. For example, it tells CodeBuild where to get the source code and which build environment to use.

**Note**  
To unset or remove a project value via CFN, explicitly provide the attribute with value as empty input. 

## Syntax
<a name="aws-resource-codebuild-project-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-codebuild-project-syntax.json"></a>

```
{
  "Type" : "AWS::CodeBuild::Project",
  "Properties" : {
      "[Artifacts](#cfn-codebuild-project-artifacts)" : Artifacts,
      "[BadgeEnabled](#cfn-codebuild-project-badgeenabled)" : Boolean,
      "[BuildBatchConfig](#cfn-codebuild-project-buildbatchconfig)" : ProjectBuildBatchConfig,
      "[Cache](#cfn-codebuild-project-cache)" : ProjectCache,
      "[ConcurrentBuildLimit](#cfn-codebuild-project-concurrentbuildlimit)" : Integer,
      "[Description](#cfn-codebuild-project-description)" : String,
      "[EncryptionKey](#cfn-codebuild-project-encryptionkey)" : String,
      "[Environment](#cfn-codebuild-project-environment)" : Environment,
      "[FileSystemLocations](#cfn-codebuild-project-filesystemlocations)" : [ ProjectFileSystemLocation, ... ],
      "[LogsConfig](#cfn-codebuild-project-logsconfig)" : LogsConfig,
      "[Name](#cfn-codebuild-project-name)" : String,
      "[QueuedTimeoutInMinutes](#cfn-codebuild-project-queuedtimeoutinminutes)" : Integer,
      "[ResourceAccessRole](#cfn-codebuild-project-resourceaccessrole)" : String,
      "[SecondaryArtifacts](#cfn-codebuild-project-secondaryartifacts)" : [ Artifacts, ... ],
      "[SecondarySources](#cfn-codebuild-project-secondarysources)" : [ Source, ... ],
      "[SecondarySourceVersions](#cfn-codebuild-project-secondarysourceversions)" : [ ProjectSourceVersion, ... ],
      "[ServiceRole](#cfn-codebuild-project-servicerole)" : String,
      "[Source](#cfn-codebuild-project-source)" : Source,
      "[SourceVersion](#cfn-codebuild-project-sourceversion)" : String,
      "[Tags](#cfn-codebuild-project-tags)" : [ Tag, ... ],
      "[TimeoutInMinutes](#cfn-codebuild-project-timeoutinminutes)" : Integer,
      "[Triggers](#cfn-codebuild-project-triggers)" : ProjectTriggers,
      "[Visibility](#cfn-codebuild-project-visibility)" : String,
      "[VpcConfig](#cfn-codebuild-project-vpcconfig)" : VpcConfig
    }
}
```

### YAML
<a name="aws-resource-codebuild-project-syntax.yaml"></a>

```
Type: AWS::CodeBuild::Project
Properties:
  [Artifacts](#cfn-codebuild-project-artifacts): 
    Artifacts
  [BadgeEnabled](#cfn-codebuild-project-badgeenabled): Boolean
  [BuildBatchConfig](#cfn-codebuild-project-buildbatchconfig): 
    ProjectBuildBatchConfig
  [Cache](#cfn-codebuild-project-cache): 
    ProjectCache
  [ConcurrentBuildLimit](#cfn-codebuild-project-concurrentbuildlimit): Integer
  [Description](#cfn-codebuild-project-description): String
  [EncryptionKey](#cfn-codebuild-project-encryptionkey): String
  [Environment](#cfn-codebuild-project-environment): 
    Environment
  [FileSystemLocations](#cfn-codebuild-project-filesystemlocations): 
    - ProjectFileSystemLocation
  [LogsConfig](#cfn-codebuild-project-logsconfig): 
    LogsConfig
  [Name](#cfn-codebuild-project-name): String
  [QueuedTimeoutInMinutes](#cfn-codebuild-project-queuedtimeoutinminutes): Integer
  [ResourceAccessRole](#cfn-codebuild-project-resourceaccessrole): String
  [SecondaryArtifacts](#cfn-codebuild-project-secondaryartifacts): 
    - Artifacts
  [SecondarySources](#cfn-codebuild-project-secondarysources): 
    - Source
  [SecondarySourceVersions](#cfn-codebuild-project-secondarysourceversions): 
    - ProjectSourceVersion
  [ServiceRole](#cfn-codebuild-project-servicerole): String
  [Source](#cfn-codebuild-project-source): 
    Source
  [SourceVersion](#cfn-codebuild-project-sourceversion): String
  [Tags](#cfn-codebuild-project-tags): 
    - Tag
  [TimeoutInMinutes](#cfn-codebuild-project-timeoutinminutes): Integer
  [Triggers](#cfn-codebuild-project-triggers): 
    ProjectTriggers
  [Visibility](#cfn-codebuild-project-visibility): String
  [VpcConfig](#cfn-codebuild-project-vpcconfig): 
    VpcConfig
```

## Properties
<a name="aws-resource-codebuild-project-properties"></a>

`Artifacts`  <a name="cfn-codebuild-project-artifacts"></a>
`Artifacts` is a property of the [ AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.  
*Required*: Yes  
*Type*: [Artifacts](aws-properties-codebuild-project-artifacts.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BadgeEnabled`  <a name="cfn-codebuild-project-badgeenabled"></a>
 Indicates whether AWS CodeBuild generates a publicly accessible URL for your project's build badge. For more information, see [Build Badges Sample](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-build-badges.html) in the *AWS CodeBuild User Guide*.   
 Including build badges with your project is currently not supported if the source type is CodePipeline. If you specify `CODEPIPELINE` for the `Source` property, do not specify the `BadgeEnabled` property. 
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BuildBatchConfig`  <a name="cfn-codebuild-project-buildbatchconfig"></a>
A `ProjectBuildBatchConfig` object that defines the batch build options for the project.   
*Required*: No  
*Type*: [ProjectBuildBatchConfig](aws-properties-codebuild-project-projectbuildbatchconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Cache`  <a name="cfn-codebuild-project-cache"></a>
Settings that AWS CodeBuild uses to store and reuse build dependencies.   
*Required*: No  
*Type*: [ProjectCache](aws-properties-codebuild-project-projectcache.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConcurrentBuildLimit`  <a name="cfn-codebuild-project-concurrentbuildlimit"></a>
The maximum number of concurrent builds that are allowed for this project.  
New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Description`  <a name="cfn-codebuild-project-description"></a>
A description that makes the build project easy to identify.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionKey`  <a name="cfn-codebuild-project-encryptionkey"></a>
The AWS Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.  
You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. 
You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format `alias/<alias-name>`). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Environment`  <a name="cfn-codebuild-project-environment"></a>
 The build environment settings for the project, such as the environment type or the environment variables to use for the build environment.   
*Required*: Yes  
*Type*: [Environment](aws-properties-codebuild-project-environment.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FileSystemLocations`  <a name="cfn-codebuild-project-filesystemlocations"></a>
 An array of `ProjectFileSystemLocation` objects for a CodeBuild build project. A `ProjectFileSystemLocation` object specifies the `identifier`, `location`, `mountOptions`, `mountPoint`, and `type` of a file system created using Amazon Elastic File System.   
*Required*: No  
*Type*: Array of [ProjectFileSystemLocation](aws-properties-codebuild-project-projectfilesystemlocation.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`LogsConfig`  <a name="cfn-codebuild-project-logsconfig"></a>
Information about logs for the build project. A project can create logs in CloudWatch Logs, an S3 bucket, or both.   
*Required*: No  
*Type*: [LogsConfig](aws-properties-codebuild-project-logsconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-codebuild-project-name"></a>
The name of the build project. The name must be unique across all of the projects in your AWS account.  
*Required*: No  
*Type*: String  
*Pattern*: `[A-Za-z0-9][A-Za-z0-9\-_]{1,149}`  
*Minimum*: `2`  
*Maximum*: `150`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`QueuedTimeoutInMinutes`  <a name="cfn-codebuild-project-queuedtimeoutinminutes"></a>
The number of minutes a build is allowed to be queued before it times out.   
*Required*: No  
*Type*: Integer  
*Minimum*: `5`  
*Maximum*: `480`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ResourceAccessRole`  <a name="cfn-codebuild-project-resourceaccessrole"></a>
The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecondaryArtifacts`  <a name="cfn-codebuild-project-secondaryartifacts"></a>
 A list of `Artifacts` objects. Each artifacts object specifies output settings that the project generates during a build.   
*Required*: No  
*Type*: Array of [Artifacts](aws-properties-codebuild-project-artifacts.md)  
*Minimum*: `0`  
*Maximum*: `12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecondarySources`  <a name="cfn-codebuild-project-secondarysources"></a>
An array of `ProjectSource` objects.   
*Required*: No  
*Type*: Array of [Source](aws-properties-codebuild-project-source.md)  
*Minimum*: `0`  
*Maximum*: `12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SecondarySourceVersions`  <a name="cfn-codebuild-project-secondarysourceversions"></a>
An array of `ProjectSourceVersion` objects. If `secondarySourceVersions` is specified at the build level, then they take over these `secondarySourceVersions` (at the project level).   
*Required*: No  
*Type*: Array of [ProjectSourceVersion](aws-properties-codebuild-project-projectsourceversion.md)  
*Minimum*: `0`  
*Maximum*: `12`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceRole`  <a name="cfn-codebuild-project-servicerole"></a>
The ARN of the IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Source`  <a name="cfn-codebuild-project-source"></a>
The source code settings for the project, such as the source code's repository type and location.   
*Required*: Yes  
*Type*: [Source](aws-properties-codebuild-project-source.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceVersion`  <a name="cfn-codebuild-project-sourceversion"></a>
A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:  
+ For CodeCommit: the commit ID, branch, or Git tag to use.
+ For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format `pr/pull-request-ID` (for example `pr/25`). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
+ For GitLab: the commit ID, branch, or Git tag to use.
+ For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
+ For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
If `sourceVersion` is specified at the build level, then that version takes precedence over this `sourceVersion` (at the project level).   
For more information, see [Source Version Sample with CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the *AWS CodeBuild User Guide*.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Tags`  <a name="cfn-codebuild-project-tags"></a>
 An arbitrary set of tags (key-value pairs) for the AWS CodeBuild project.   
These tags are available for use by AWS services that support AWS CodeBuild build project tags.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-codebuild-project-tag.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutInMinutes`  <a name="cfn-codebuild-project-timeoutinminutes"></a>
How long, in minutes, from 5 to 2160 (36 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.  
*Required*: No  
*Type*: Integer  
*Minimum*: `5`  
*Maximum*: `2160`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Triggers`  <a name="cfn-codebuild-project-triggers"></a>
 For an existing AWS CodeBuild build project that has its source code stored in a GitHub repository, enables AWS CodeBuild to begin automatically rebuilding the source code every time a code change is pushed to the repository.   
*Required*: No  
*Type*: [ProjectTriggers](aws-properties-codebuild-project-projecttriggers.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Visibility`  <a name="cfn-codebuild-project-visibility"></a>
Specifies the visibility of the project's builds. Possible values are:    
PUBLIC\$1READ  
The project builds are visible to the public.  
PRIVATE  
The project builds are not visible to the public.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcConfig`  <a name="cfn-codebuild-project-vpcconfig"></a>
`VpcConfig` specifies settings that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see [Use AWS CodeBuild with Amazon Virtual Private Cloud](https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html) in the *AWS CodeBuild User Guide*.   
*Required*: No  
*Type*: [VpcConfig](aws-properties-codebuild-project-vpcconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Return values
<a name="aws-resource-codebuild-project-return-values"></a>

### Ref
<a name="aws-resource-codebuild-project-return-values-ref"></a>

When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the name of the AWS CodeBuild project, such as `myProjectName`.

For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-codebuild-project-return-values-fn--getatt"></a>

`Fn::GetAtt` returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using `Fn::GetAtt`, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-codebuild-project-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the AWS CodeBuild project, such as `arn:aws:codebuild:us-west-2:123456789012:project/myProjectName`.

## Examples
<a name="aws-resource-codebuild-project--examples"></a>



**Topics**
+ [Create a project](#aws-resource-codebuild-project--examples--Create_a_project)
+ [Create a project with two filter groups.](#aws-resource-codebuild-project--examples--Create_a_project_with_two_filter_groups.)
+ [Create a project using Amazon S3 and Amazon VPC](#aws-resource-codebuild-project--examples--Create_a_project_using_Amazon_S3_and_Amazon_VPC)

### Create a project
<a name="aws-resource-codebuild-project--examples--Create_a_project"></a>

The following example creates an AWS CodeBuild project.

#### JSON
<a name="aws-resource-codebuild-project--examples--Create_a_project--json"></a>

```
{
  "Project": {
    "Type": "AWS::CodeBuild::Project",
    "Properties": {
      "Name": "myProjectName",
      "Description": "A description about my project",
      "ServiceRole": { "Fn::GetAtt": [ "ServiceRole", "Arn" ] },
      "Artifacts": {
        "Type": "no_artifacts"
      },
      "Environment": {
        "Type": "LINUX_CONTAINER",
        "ComputeType": "BUILD_GENERAL1_SMALL",
        "Image": "aws/codebuild/java:openjdk-8",
        "EnvironmentVariables": [
          {
            "Name": "varName",
            "Type": "varType",
            "Value": "varValue"
          }
        ]
      },
      "Source": {
        "Location": "codebuild-demo-test/0123ab9a371ebf0187b0fe5614fbb72c",
        "Type": "S3"
      },
      "TimeoutInMinutes": 10,
      "Tags": [
        {
          "Key": "Key1",
          "Value": "Value1"
        },
        {
          "Key": "Key2",
          "Value": "Value2"
        }
      ]
    }
  }
}
```

#### YAML
<a name="aws-resource-codebuild-project--examples--Create_a_project--yaml"></a>

```
Project:
  Type: AWS::CodeBuild::Project
  Properties:
    Name: myProjectName
    Description: A description about my project
    ServiceRole: !GetAtt ServiceRole.Arn
    Artifacts:
      Type: no_artifacts
    Environment:
      Type: LINUX_CONTAINER
      ComputeType: BUILD_GENERAL1_SMALL
      Image: aws/codebuild/java:openjdk-8
      EnvironmentVariables:
      - Name: varName
        Type: varType
        Value: varValue
    Source:
      Location: codebuild-demo-test/0123ab9a371ebf0187b0fe5614fbb72c
      Type: S3
    TimeoutInMinutes: 10
    Tags:
      - Key: Key1
        Value: Value1
      - Key: Key2
        Value: Value2
```

### Create a project with two filter groups.
<a name="aws-resource-codebuild-project--examples--Create_a_project_with_two_filter_groups."></a>

 The following example creates a project with two filter groups. Together, they trigger a build when one or both evaluate to true: 
+  The first filter group specifies pull requests are created or updated on branches with Git reference names that match the regular expression `^refs/heads/master$` by a GitHub user that does not have account ID `12345`. 
+  The second filter group specifies push requests are created on files with names that match the regular expression `READ_ME` in branches with Git reference names that match the regular expression `^refs/heads/.*`. 

 For this example, the name of the service role is `my-example-service-role`. The name of the source location is `my-example-source-location`. 

#### YAML
<a name="aws-resource-codebuild-project--examples--Create_a_project_with_two_filter_groups.--yaml"></a>

```
CodeBuildProject:
  Type: AWS::CodeBuild::Project
  Properties:
    Name: MyProject
    ServiceRole: my-example-service-role
    Artifacts:
      Type: NO_ARTIFACTS
    Environment:
      Type: LINUX_CONTAINER
      ComputeType: BUILD_GENERAL1_SMALL
      Image: aws/codebuild/standard:1.0
    Source:
      Type: GITHUB
      Location: my-example-source-location
    Triggers:
      Webhook: true
      FilterGroups:
        - - Type: EVENT
            Pattern: PULL_REQUEST_CREATED,PULL_REQUEST_UPDATED
          - Type: BASE_REF
            Pattern: ^refs/heads/master$
            ExcludeMatchedPattern: false
          - Type: ACTOR_ACCOUNT_ID
            Pattern: 12345
            ExcludeMatchedPattern: true
        - - Type: EVENT
            Pattern: PUSH
          - Type: HEAD_REF
            Pattern: ^refs/heads/.*
          - Type: FILE_PATH
            Pattern: READ_ME
            ExcludeMatchedPattern: true
```

#### JSON
<a name="aws-resource-codebuild-project--examples--Create_a_project_with_two_filter_groups.--json"></a>

```
{
    "CodeBuildProject": {
        "Type": "AWS::CodeBuild::Project",
        "Properties": {
            "Name": "MyProject",
            "ServiceRole": "my-example-service-role",
            "Artifacts": {
                "Type": "NO_ARTIFACTS"
            },
            "Environment": {
                "Type": "LINUX_CONTAINER",
                "ComputeType": "BUILD_GENERAL1_SMALL",
                "Image": "aws/codebuild/standard:1.0"
            },
            "Source": {
                "Type": "GITHUB",
                "Location": "my-example-source-location"
            },
            "Triggers": {
                "Webhook": true,
                "FilterGroups": [
                    [
                        {
                            "Type": "EVENT",
                            "Pattern": "PULL_REQUEST_CREATED,PULL_REQUEST_UPDATED"
                        },
                        {
                            "Type": "BASE_REF",
                            "Pattern": "^refs/heads/master$",
                            "ExcludeMatchedPattern": false
                        },
                        {
                            "Type": "ACTOR_ACCOUNT_ID",
                            "Pattern": 12345,
                            "ExcludeMatchedPattern": true
                        }
                    ],
                    [
                        {
                            "Type": "EVENT",
                            "Pattern": "PUSH"
                        },
                        {
                            "Type": "HEAD_REF",
                            "Pattern": "^refs/heads/.*"
                        },
                        {
                            "Type": "FILE_PATH",
                            "Pattern": "READ_ME",
                            "ExcludeMatchedPattern": true
                        }
                    ]
                ]
            }
        }
    }
}
```

### Create a project using Amazon S3 and Amazon VPC
<a name="aws-resource-codebuild-project--examples--Create_a_project_using_Amazon_S3_and_Amazon_VPC"></a>

The following example creates a project that caches build dependencies in Amazon S3 and uses resources in an Amazon VPC.

#### YAML
<a name="aws-resource-codebuild-project--examples--Create_a_project_using_Amazon_S3_and_Amazon_VPC--yaml"></a>

```
Resources:
  CodeBuildProject:
    Type: AWS::CodeBuild::Project
    Properties:
      ServiceRole: !GetAtt CodeBuildRole.Arn
      Artifacts:
        Type: CODEPIPELINE
      Environment:
        Type: LINUX_CONTAINER
        ComputeType: BUILD_GENERAL1_SMALL
        Image: aws/codebuild/ubuntu-base:14.04
        EnvironmentVariables:
          - Name: varName1
            Value: varValue1
          - Name: varName2
            Value: varValue2
            Type: PLAINTEXT
          - Name: varName3
            Value: /CodeBuild/testParameter
            Type: PARAMETER_STORE
      Source:
        Type: CODEPIPELINE
      TimeoutInMinutes: 10
      VpcConfig:
        VpcId: !Ref CodeBuildVPC
        Subnets: [!Ref CodeBuildSubnet]
        SecurityGroupIds: [!Ref CodeBuildSecurityGroup]
      Cache:
        Type: S3
        Location: <mybucket/prefix>
  CodeBuildRole:
    Type: AWS::IAM::Role
    Properties:
      AssumeRolePolicyDocument:
        Statement:
        - Action: ['sts:AssumeRole']
          Effect: Allow
          Principal:
            Service: [codebuild.amazonaws.com]
        Version: '2012-10-17		 	 	 '
      Path: /
      Policies:
        - PolicyName: CodeBuildAccess
          PolicyDocument:
            Version: '2012-10-17		 	 	 '
            Statement:
              - Action:
                - 'logs:*'
                - 'ec2:CreateNetworkInterface'
                - 'ec2:DescribeNetworkInterfaces'
                - 'ec2:DeleteNetworkInterface'
                - 'ec2:DescribeSubnets'
                - 'ec2:DescribeSecurityGroups'
                - 'ec2:DescribeDhcpOptions'
                - 'ec2:DescribeVpcs'
                - 'ec2:CreateNetworkInterfacePermission'
                Effect: Allow
                Resource: '*'
  CodeBuildVPC:
    Type: AWS::EC2::VPC
    Properties:
      CidrBlock: 10.0.0.0/16
      EnableDnsSupport: 'true'
      EnableDnsHostnames: 'true'
      Tags:
        - Key: name
          Value: codebuild
  CodeBuildSubnet:
    Type: AWS::EC2::Subnet
    Properties:
      VpcId:
        Ref: CodeBuildVPC
      CidrBlock: 10.0.1.0/24
  CodeBuildSecurityGroup:
    Type: AWS::EC2::SecurityGroup
    Properties:
      GroupName: Codebuild Internet Group
      GroupDescription: 'CodeBuild SecurityGroup'
      VpcId: !Ref CodeBuildVPC
```

#### JSON
<a name="aws-resource-codebuild-project--examples--Create_a_project_using_Amazon_S3_and_Amazon_VPC--json"></a>

```
{
  "Resources": {
    "CodeBuildProject": {
      "Type": "AWS::CodeBuild::Project",
      "Properties": {
        "ServiceRole": {
          "Fn::GetAtt": [
            "CodeBuildRole",
            "Arn"
          ]
        },
        "Artifacts": {
          "Type": "CODEPIPELINE"
        },
        "Environment": {
          "Type": "LINUX_CONTAINER",
          "ComputeType": "BUILD_GENERAL1_SMALL",
          "Image": "aws/codebuild/ubuntu-base:14.04",
          "EnvironmentVariables": [
            {
              "Name": "varName1",
              "Value": "varValue1"
            },
            {
              "Name": "varName2",
              "Value": "varValue2",
              "Type": "PLAINTEXT"
            },
            {
              "Name": "varName3",
              "Value": "/CodeBuild/testParameter",
              "Type": "PARAMETER_STORE"
            }
          ]
        },
        "Source": {
          "Type": "CODEPIPELINE"
        },
        "TimeoutInMinutes": 10,
        "VpcConfig": {
          "VpcId": {
            "Ref": "CodeBuildVPC"
          },
          "Subnets": [
            {
              "Ref": "CodeBuildSubnet"
            }
          ],
          "SecurityGroupIds": [
            {
              "Ref": "CodeBuildSecurityGroup"
            }
          ]
        },
        "Cache": {
          "Type": "S3",
          "Location": "<mybucket/prefix>"
        }
      }
    },
    "CodeBuildRole": {
      "Type": "AWS::IAM::Role",
      "Properties": {
        "AssumeRolePolicyDocument": {
          "Statement": [
            {
              "Action": [
                "sts:AssumeRole"
              ],
              "Effect": "Allow",
              "Principal": {
                "Service": [
                  "codebuild.amazonaws.com"
                ]
              }
            }
          ],
          "Version": "2012-10-17"		 	 	 
        },
        "Path": "/",
        "Policies": [
          {
            "PolicyName": "CodeBuildAccess",
            "PolicyDocument": {
              "Version": "2012-10-17",		 	 	 
              "Statement": [
                {
                  "Action": [
                    "logs:*",
                    "ec2:CreateNetworkInterface",
                    "ec2:DescribeNetworkInterfaces",
                    "ec2:DeleteNetworkInterface",
                    "ec2:DescribeSubnets",
                    "ec2:DescribeSecurityGroups",
                    "ec2:DescribeDhcpOptions",
                    "ec2:DescribeVpcs",
                    "ec2:CreateNetworkInterfacePermission"
                  ],
                  "Effect": "Allow",
                  "Resource": "*"
                }
              ]
            }
          }
        ]
      }
    },
    "CodeBuildVPC": {
      "Type": "AWS::EC2::VPC",
      "Properties": {
        "CidrBlock": "10.0.0.0/16",
        "EnableDnsSupport": "true",
        "EnableDnsHostnames": "true",
        "Tags": [
          {
            "Key": "name",
            "Value": "codebuild"
          }
        ]
      }
    },
    "CodeBuildSubnet": {
      "Type": "AWS::EC2::Subnet",
      "Properties": {
        "VpcId": {
          "Ref": "CodeBuildVPC"
        },
        "CidrBlock": "10.0.1.0/24"
      }
    },
    "CodeBuildSecurityGroup": {
      "Type": "AWS::EC2::SecurityGroup",
      "Properties": {
        "GroupName": "Codebuild Internet Group",
        "GroupDescription": "CodeBuild SecurityGroup",
        "VpcId": {
          "Ref": "CodeBuildVPC"
        }
      }
    }
  }
}
```

## See also
<a name="aws-resource-codebuild-project--seealso"></a>
+ [ CreateProject](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_CreateProject.html) in the *AWS CodeBuild API Reference*

# AWS::CodeBuild::Project Artifacts
<a name="aws-properties-codebuild-project-artifacts"></a>

`Artifacts` is a property of the [ AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

## Syntax
<a name="aws-properties-codebuild-project-artifacts-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-artifacts-syntax.json"></a>

```
{
  "[ArtifactIdentifier](#cfn-codebuild-project-artifacts-artifactidentifier)" : String,
  "[EncryptionDisabled](#cfn-codebuild-project-artifacts-encryptiondisabled)" : Boolean,
  "[Location](#cfn-codebuild-project-artifacts-location)" : String,
  "[Name](#cfn-codebuild-project-artifacts-name)" : String,
  "[NamespaceType](#cfn-codebuild-project-artifacts-namespacetype)" : String,
  "[OverrideArtifactName](#cfn-codebuild-project-artifacts-overrideartifactname)" : Boolean,
  "[Packaging](#cfn-codebuild-project-artifacts-packaging)" : String,
  "[Path](#cfn-codebuild-project-artifacts-path)" : String,
  "[Type](#cfn-codebuild-project-artifacts-type)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-artifacts-syntax.yaml"></a>

```
  [ArtifactIdentifier](#cfn-codebuild-project-artifacts-artifactidentifier): String
  [EncryptionDisabled](#cfn-codebuild-project-artifacts-encryptiondisabled): Boolean
  [Location](#cfn-codebuild-project-artifacts-location): String
  [Name](#cfn-codebuild-project-artifacts-name): String
  [NamespaceType](#cfn-codebuild-project-artifacts-namespacetype): String
  [OverrideArtifactName](#cfn-codebuild-project-artifacts-overrideartifactname): Boolean
  [Packaging](#cfn-codebuild-project-artifacts-packaging): String
  [Path](#cfn-codebuild-project-artifacts-path): String
  [Type](#cfn-codebuild-project-artifacts-type): String
```

## Properties
<a name="aws-properties-codebuild-project-artifacts-properties"></a>

`ArtifactIdentifier`  <a name="cfn-codebuild-project-artifacts-artifactidentifier"></a>
 An identifier for this artifact definition.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionDisabled`  <a name="cfn-codebuild-project-artifacts-encryptiondisabled"></a>
 Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an `invalidInputException` is thrown.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Location`  <a name="cfn-codebuild-project-artifacts-location"></a>
Information about the build output artifact location:  
+ If `type` is set to `CODEPIPELINE`, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.
+ If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
+ If `type` is set to `S3`, this is the name of the output bucket.
 If you specify `CODEPIPELINE` or `NO_ARTIFACTS` for the `Type` property, don't specify this property. For all of the other types, you must specify this property.   
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-codebuild-project-artifacts-name"></a>
Along with `path` and `namespaceType`, the pattern that AWS CodeBuild uses to name and store the output artifact:  
+ If `type` is set to `CODEPIPELINE`, AWS CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild.
+ If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
+ If `type` is set to `S3`, this is the name of the output artifact object. If you set the name to be a forward slash ("/"), the artifact is stored in the root of the output bucket.
For example:  
+  If `path` is set to `MyArtifacts`, `namespaceType` is set to `BUILD_ID`, and `name` is set to `MyArtifact.zip`, then the output artifact is stored in `MyArtifacts/build-ID/MyArtifact.zip`. 
+  If `path` is empty, `namespaceType` is set to `NONE`, and `name` is set to "`/`", the output artifact is stored in the root of the output bucket. 
+  If `path` is set to `MyArtifacts`, `namespaceType` is set to `BUILD_ID`, and `name` is set to "`/`", the output artifact is stored in `MyArtifacts/build-ID`. 
 If you specify `CODEPIPELINE` or `NO_ARTIFACTS` for the `Type` property, don't specify this property. For all of the other types, you must specify this property.   
*Required*: Conditional  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`NamespaceType`  <a name="cfn-codebuild-project-artifacts-namespacetype"></a>
Along with `path` and `name`, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:  
+ If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild.
+ If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
+ If `type` is set to `S3`, valid values include:
  + `BUILD_ID`: Include the build ID in the location of the build output artifact.
  + `NONE`: Do not include the build ID. This is the default if `namespaceType` is not specified.
For example, if `path` is set to `MyArtifacts`, `namespaceType` is set to `BUILD_ID`, and `name` is set to `MyArtifact.zip`, the output artifact is stored in `MyArtifacts/<build-ID>/MyArtifact.zip`.  
*Required*: No  
*Type*: String  
*Allowed values*: `NONE | BUILD_ID`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`OverrideArtifactName`  <a name="cfn-codebuild-project-artifacts-overrideartifactname"></a>
 If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell command language. For example, you can append a date and time to your artifact name so that it is always unique.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Packaging`  <a name="cfn-codebuild-project-artifacts-packaging"></a>
The type of build output artifact to create:  
+ If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of AWS CodeBuild.
+ If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
+ If `type` is set to `S3`, valid values include:
  + `NONE`: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if `packaging` is not specified.
  + `ZIP`: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.
*Required*: No  
*Type*: String  
*Allowed values*: `NONE | ZIP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Path`  <a name="cfn-codebuild-project-artifacts-path"></a>
Along with `namespaceType` and `name`, the pattern that AWS CodeBuild uses to name and store the output artifact:  
+ If `type` is set to `CODEPIPELINE`, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of AWS CodeBuild.
+ If `type` is set to `NO_ARTIFACTS`, this value is ignored if specified, because no build output is produced.
+ If `type` is set to `S3`, this is the path to the output artifact. If `path` is not specified, `path` is not used.
For example, if `path` is set to `MyArtifacts`, `namespaceType` is set to `NONE`, and `name` is set to `MyArtifact.zip`, the output artifact is stored in the output bucket at `MyArtifacts/MyArtifact.zip`.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-project-artifacts-type"></a>
The type of build output artifact. Valid values include:  
+ `CODEPIPELINE`: The build project has build output generated through CodePipeline. 
**Note**  
The `CODEPIPELINE` type is not supported for `secondaryArtifacts`.
+ `NO_ARTIFACTS`: The build project does not produce any build output.
+ `S3`: The build project stores build output in Amazon S3.
*Required*: Yes  
*Type*: String  
*Allowed values*: `CODEPIPELINE | S3 | NO_ARTIFACTS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project BatchRestrictions
<a name="aws-properties-codebuild-project-batchrestrictions"></a>

Specifies restrictions for the batch build.

## Syntax
<a name="aws-properties-codebuild-project-batchrestrictions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-batchrestrictions-syntax.json"></a>

```
{
  "[ComputeTypesAllowed](#cfn-codebuild-project-batchrestrictions-computetypesallowed)" : [ String, ... ],
  "[MaximumBuildsAllowed](#cfn-codebuild-project-batchrestrictions-maximumbuildsallowed)" : Integer
}
```

### YAML
<a name="aws-properties-codebuild-project-batchrestrictions-syntax.yaml"></a>

```
  [ComputeTypesAllowed](#cfn-codebuild-project-batchrestrictions-computetypesallowed): 
    - String
  [MaximumBuildsAllowed](#cfn-codebuild-project-batchrestrictions-maximumbuildsallowed): Integer
```

## Properties
<a name="aws-properties-codebuild-project-batchrestrictions-properties"></a>

`ComputeTypesAllowed`  <a name="cfn-codebuild-project-batchrestrictions-computetypesallowed"></a>
An array of strings that specify the compute types that are allowed for the batch build. See [Build environment compute types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild User Guide* for these values.   
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MaximumBuildsAllowed`  <a name="cfn-codebuild-project-batchrestrictions-maximumbuildsallowed"></a>
Specifies the maximum number of builds allowed.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project BuildStatusConfig
<a name="aws-properties-codebuild-project-buildstatusconfig"></a>

Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider. 

## Syntax
<a name="aws-properties-codebuild-project-buildstatusconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-buildstatusconfig-syntax.json"></a>

```
{
  "[Context](#cfn-codebuild-project-buildstatusconfig-context)" : String,
  "[TargetUrl](#cfn-codebuild-project-buildstatusconfig-targeturl)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-buildstatusconfig-syntax.yaml"></a>

```
  [Context](#cfn-codebuild-project-buildstatusconfig-context): String
  [TargetUrl](#cfn-codebuild-project-buildstatusconfig-targeturl): String
```

## Properties
<a name="aws-properties-codebuild-project-buildstatusconfig-properties"></a>

`Context`  <a name="cfn-codebuild-project-buildstatusconfig-context"></a>
Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.    
Bitbucket  
This parameter is used for the `name` parameter in the Bitbucket commit status. For more information, see [build](https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) in the Bitbucket API documentation.  
GitHub/GitHub Enterprise Server  
This parameter is used for the `context` parameter in the GitHub commit status. For more information, see [Create a commit status](https://developer.github.com/v3/repos/statuses/#create-a-commit-status) in the GitHub developer guide.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TargetUrl`  <a name="cfn-codebuild-project-buildstatusconfig-targeturl"></a>
Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.    
Bitbucket  
This parameter is used for the `url` parameter in the Bitbucket commit status. For more information, see [build](https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build) in the Bitbucket API documentation.  
GitHub/GitHub Enterprise Server  
This parameter is used for the `target_url` parameter in the GitHub commit status. For more information, see [Create a commit status](https://developer.github.com/v3/repos/statuses/#create-a-commit-status) in the GitHub developer guide.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project CloudWatchLogsConfig
<a name="aws-properties-codebuild-project-cloudwatchlogsconfig"></a>

`CloudWatchLogs` is a property of the [AWS CodeBuild Project LogsConfig ](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html) property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build. 

## Syntax
<a name="aws-properties-codebuild-project-cloudwatchlogsconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-cloudwatchlogsconfig-syntax.json"></a>

```
{
  "[GroupName](#cfn-codebuild-project-cloudwatchlogsconfig-groupname)" : String,
  "[Status](#cfn-codebuild-project-cloudwatchlogsconfig-status)" : String,
  "[StreamName](#cfn-codebuild-project-cloudwatchlogsconfig-streamname)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-cloudwatchlogsconfig-syntax.yaml"></a>

```
  [GroupName](#cfn-codebuild-project-cloudwatchlogsconfig-groupname): String
  [Status](#cfn-codebuild-project-cloudwatchlogsconfig-status): String
  [StreamName](#cfn-codebuild-project-cloudwatchlogsconfig-streamname): String
```

## Properties
<a name="aws-properties-codebuild-project-cloudwatchlogsconfig-properties"></a>

`GroupName`  <a name="cfn-codebuild-project-cloudwatchlogsconfig-groupname"></a>
 The group name of the logs in CloudWatch Logs. For more information, see [Working with Log Groups and Log Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html).   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-codebuild-project-cloudwatchlogsconfig-status"></a>
The current status of the logs in CloudWatch Logs for a build project. Valid values are:  
+ `ENABLED`: CloudWatch Logs are enabled for this build project.
+ `DISABLED`: CloudWatch Logs are not enabled for this build project.
*Required*: Yes  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`StreamName`  <a name="cfn-codebuild-project-cloudwatchlogsconfig-streamname"></a>
 The prefix of the stream name of the CloudWatch Logs. For more information, see [Working with Log Groups and Log Streams](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html).   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-codebuild-project-cloudwatchlogsconfig--seealso"></a>
+ [ CloudWatchLogsConfig](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_CloudWatchLogsConfig.html) in the *AWS CodeBuild API Reference*

# AWS::CodeBuild::Project Environment
<a name="aws-properties-codebuild-project-environment"></a>

`Environment` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies the environment for an AWS CodeBuild project. 

## Syntax
<a name="aws-properties-codebuild-project-environment-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-environment-syntax.json"></a>

```
{
  "[Certificate](#cfn-codebuild-project-environment-certificate)" : String,
  "[ComputeType](#cfn-codebuild-project-environment-computetype)" : String,
  "[EnvironmentVariables](#cfn-codebuild-project-environment-environmentvariables)" : [ EnvironmentVariable, ... ],
  "[Fleet:](#cfn-codebuild-project-environment-fleet:)" : ProjectFleet,
  "[Image](#cfn-codebuild-project-environment-image)" : String,
  "[ImagePullCredentialsType](#cfn-codebuild-project-environment-imagepullcredentialstype)" : String,
  "[PrivilegedMode](#cfn-codebuild-project-environment-privilegedmode)" : Boolean,
  "[RegistryCredential](#cfn-codebuild-project-environment-registrycredential)" : RegistryCredential,
  "[Type](#cfn-codebuild-project-environment-type)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-environment-syntax.yaml"></a>

```
  [Certificate](#cfn-codebuild-project-environment-certificate): String
  [ComputeType](#cfn-codebuild-project-environment-computetype): String
  [EnvironmentVariables](#cfn-codebuild-project-environment-environmentvariables): 
    - EnvironmentVariable
  [Fleet:](#cfn-codebuild-project-environment-fleet:): 
    ProjectFleet
  [Image](#cfn-codebuild-project-environment-image): String
  [ImagePullCredentialsType](#cfn-codebuild-project-environment-imagepullcredentialstype): String
  [PrivilegedMode](#cfn-codebuild-project-environment-privilegedmode): Boolean
  [RegistryCredential](#cfn-codebuild-project-environment-registrycredential): 
    RegistryCredential
  [Type](#cfn-codebuild-project-environment-type): String
```

## Properties
<a name="aws-properties-codebuild-project-environment-properties"></a>

`Certificate`  <a name="cfn-codebuild-project-environment-certificate"></a>
The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see [certificate](https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate) in the *AWS CodeBuild User Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ComputeType`  <a name="cfn-codebuild-project-environment-computetype"></a>
The type of compute environment. This determines the number of CPU cores and memory the build environment uses. Available values include:  
+ `ATTRIBUTE_BASED_COMPUTE`: Specify the amount of vCPUs, memory, disk space, and the type of machine.
**Note**  
 If you use `ATTRIBUTE_BASED_COMPUTE`, you must define your attributes by using `computeConfiguration`. AWS CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see [Reserved capacity environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment-reserved-capacity.types) in the *AWS CodeBuild User Guide*.
+ `BUILD_GENERAL1_SMALL`: Use up to 4 GiB memory and 2 vCPUs for builds.
+ `BUILD_GENERAL1_MEDIUM`: Use up to 8 GiB memory and 4 vCPUs for builds.
+ `BUILD_GENERAL1_LARGE`: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
+ `BUILD_GENERAL1_XLARGE`: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
+ `BUILD_GENERAL1_2XLARGE`: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
+ `BUILD_LAMBDA_1GB`: Use up to 1 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
+ `BUILD_LAMBDA_2GB`: Use up to 2 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
+ `BUILD_LAMBDA_4GB`: Use up to 4 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
+ `BUILD_LAMBDA_8GB`: Use up to 8 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
+ `BUILD_LAMBDA_10GB`: Use up to 10 GiB memory for builds. Only available for environment type `LINUX_LAMBDA_CONTAINER` and `ARM_LAMBDA_CONTAINER`.
 If you use `BUILD_GENERAL1_SMALL`:   
+  For environment type `LINUX_CONTAINER`, you can use up to 4 GiB memory and 2 vCPUs for builds. 
+  For environment type `LINUX_GPU_CONTAINER`, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
+  For environment type `ARM_CONTAINER`, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.
 If you use `BUILD_GENERAL1_LARGE`:   
+  For environment type `LINUX_CONTAINER`, you can use up to 16 GiB memory and 8 vCPUs for builds. 
+  For environment type `LINUX_GPU_CONTAINER`, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
+  For environment type `ARM_CONTAINER`, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.
For more information, see [On-demand environment types](https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html#environment.types) in the *AWS CodeBuild User Guide.*  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EnvironmentVariables`  <a name="cfn-codebuild-project-environment-environmentvariables"></a>
A set of environment variables to make available to builds for this build project.  
*Required*: No  
*Type*: Array of [EnvironmentVariable](aws-properties-codebuild-project-environmentvariable.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Fleet:`  <a name="cfn-codebuild-project-environment-fleet:"></a>
Property description not available.  
*Required*: No  
*Type*: [ProjectFleet](aws-properties-codebuild-project-projectfleet.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Image`  <a name="cfn-codebuild-project-environment-image"></a>
The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:  
+ For an image tag: `<registry>/<repository>:<tag>`. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be `aws/codebuild/standard:4.0`. 
+ For an image digest: `<registry>/<repository>@<digest>`. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use `<registry>/<repository>@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf`.
For more information, see [Docker images provided by CodeBuild](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-available.html) in the *AWS CodeBuild user guide*.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ImagePullCredentialsType`  <a name="cfn-codebuild-project-environment-imagepullcredentialstype"></a>
 The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:   
+ `CODEBUILD` specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild service principal. 
+ `SERVICE_ROLE` specifies that AWS CodeBuild uses your build project's service role. 
 When you use a cross-account or private registry image, you must use SERVICE\$1ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials.   
*Required*: No  
*Type*: String  
*Allowed values*: `CODEBUILD | SERVICE_ROLE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`PrivilegedMode`  <a name="cfn-codebuild-project-environment-privilegedmode"></a>
Enables running the Docker daemon inside a Docker container. Set to true only if the build project is used to build Docker images. Otherwise, a build that attempts to interact with the Docker daemon fails. The default setting is `false`.  
You can initialize the Docker daemon during the install phase of your build by adding one of the following sets of commands to the install phase of your buildspec file:  
If the operating system's base image is Ubuntu Linux:  
 `- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&`   
 `- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"`   
If the operating system's base image is Alpine Linux and the previous command does not work, add the `-t` argument to `timeout`:  
 `- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&`   
 `- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"`   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`RegistryCredential`  <a name="cfn-codebuild-project-environment-registrycredential"></a>
`RegistryCredential` is a property of the [AWS::CodeBuild::Project Environment ](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html#cfn-codebuild-project-environment) property that specifies information about credentials that provide access to a private Docker registry. When this is set:  
+ `imagePullCredentialsType` must be set to `SERVICE_ROLE`. 
+  images cannot be curated or an Amazon ECR image. 
*Required*: No  
*Type*: [RegistryCredential](aws-properties-codebuild-project-registrycredential.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-project-environment-type"></a>
The type of build environment to use for related builds.  
If you're using compute fleets during project creation, `type` will be ignored.
For more information, see [Build environment compute types](https://docs.aws.amazon.com//codebuild/latest/userguide/build-env-ref-compute-types.html) in the *AWS CodeBuild user guide*.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `WINDOWS_CONTAINER | LINUX_CONTAINER | LINUX_GPU_CONTAINER | ARM_CONTAINER | WINDOWS_SERVER_2019_CONTAINER | WINDOWS_SERVER_2022_CONTAINER | LINUX_LAMBDA_CONTAINER | ARM_LAMBDA_CONTAINER | LINUX_EC2 | ARM_EC2 | WINDOWS_EC2 | MAC_ARM`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project EnvironmentVariable
<a name="aws-properties-codebuild-project-environmentvariable"></a>

`EnvironmentVariable` is a property of the [AWS CodeBuild Project Environment](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html) property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment. When you use the environment to run a build, these variables are available for your builds to use. `EnvironmentVariable` contains a list of `EnvironmentVariable` property types.

## Syntax
<a name="aws-properties-codebuild-project-environmentvariable-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-environmentvariable-syntax.json"></a>

```
{
  "[Name](#cfn-codebuild-project-environmentvariable-name)" : String,
  "[Type](#cfn-codebuild-project-environmentvariable-type)" : String,
  "[Value](#cfn-codebuild-project-environmentvariable-value)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-environmentvariable-syntax.yaml"></a>

```
  [Name](#cfn-codebuild-project-environmentvariable-name): String
  [Type](#cfn-codebuild-project-environmentvariable-type): String
  [Value](#cfn-codebuild-project-environmentvariable-value): String
```

## Properties
<a name="aws-properties-codebuild-project-environmentvariable-properties"></a>

`Name`  <a name="cfn-codebuild-project-environmentvariable-name"></a>
The name or key of the environment variable.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-project-environmentvariable-type"></a>
The type of environment variable. Valid values include:  
+ `PARAMETER_STORE`: An environment variable stored in Systems Manager Parameter Store. For environment variables of this type, specify the name of the parameter as the `value` of the EnvironmentVariable. The parameter value will be substituted for the name at runtime. You can also define Parameter Store environment variables in the buildspec. To learn how to do so, see [env/parameter-store](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.parameter-store) in the *AWS CodeBuild User Guide*.
+ `PLAINTEXT`: An environment variable in plain text format. This is the default value.
+ `SECRETS_MANAGER`: An environment variable stored in AWS Secrets Manager. For environment variables of this type, specify the name of the secret as the `value` of the EnvironmentVariable. The secret value will be substituted for the name at runtime. You can also define AWS Secrets Manager environment variables in the buildspec. To learn how to do so, see [env/secrets-manager](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec.env.secrets-manager) in the *AWS CodeBuild User Guide*.
*Required*: No  
*Type*: String  
*Allowed values*: `PLAINTEXT | PARAMETER_STORE | SECRETS_MANAGER`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-codebuild-project-environmentvariable-value"></a>
The value of the environment variable.  
We strongly discourage the use of `PLAINTEXT` environment variables to store sensitive values, especially AWS secret key IDs. `PLAINTEXT` environment variables can be displayed in plain text using the AWS CodeBuild console and the AWS CLI. For sensitive values, we recommend you use an environment variable of type `PARAMETER_STORE` or `SECRETS_MANAGER`. 
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Examples
<a name="aws-properties-codebuild-project-environmentvariable--examples"></a>



### 
<a name="aws-properties-codebuild-project-environmentvariable--examples--"></a>

#### JSON
<a name="aws-properties-codebuild-project-environmentvariable--examples----json"></a>

```
{
  "Project": {
    "Environment": {
      "EnvironmentVariables": [
        {
          "Name": "MY_VAR_1",
          "Type": "PLAINTEXT",
          "Value": "VAR_1_VALUE"
        },
        {
          "Name": "MY_VAR_2",
          "Type": "PLAINTEXT",
          "Value": "VAR_2_VALUE"
        }
      ]
    }
  }
}
```

#### YAML
<a name="aws-properties-codebuild-project-environmentvariable--examples----yaml"></a>

```
Project:
  Type: AWS::CodeBuild::Project
  Properties:
    Environment:
      EnvironmentVariables:
        - Name: MY_VAR_1
          Type: PLAINTEXT
          Value: VAR_1_VALUE
        - Name: MY_VAR_2
          Type: PLAINTEXT
          Value: VAR_2_VALUE
```

# AWS::CodeBuild::Project GitSubmodulesConfig
<a name="aws-properties-codebuild-project-gitsubmodulesconfig"></a>

`GitSubmodulesConfig` is a property of the [AWS CodeBuild Project Source](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html) property type that specifies information about the Git submodules configuration for the build project. 

## Syntax
<a name="aws-properties-codebuild-project-gitsubmodulesconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-gitsubmodulesconfig-syntax.json"></a>

```
{
  "[FetchSubmodules](#cfn-codebuild-project-gitsubmodulesconfig-fetchsubmodules)" : Boolean
}
```

### YAML
<a name="aws-properties-codebuild-project-gitsubmodulesconfig-syntax.yaml"></a>

```
  [FetchSubmodules](#cfn-codebuild-project-gitsubmodulesconfig-fetchsubmodules): Boolean
```

## Properties
<a name="aws-properties-codebuild-project-gitsubmodulesconfig-properties"></a>

`FetchSubmodules`  <a name="cfn-codebuild-project-gitsubmodulesconfig-fetchsubmodules"></a>
 Set to true to fetch Git submodules for your AWS CodeBuild build project.   
*Required*: Yes  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-codebuild-project-gitsubmodulesconfig--seealso"></a>
+ [ GitSubmodulesConfig](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_GitSubmodulesConfig.html) in the *AWS CodeBuild API Reference*

# AWS::CodeBuild::Project LogsConfig
<a name="aws-properties-codebuild-project-logsconfig"></a>

`LogsConfig` is a property of the [AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both. 

## Syntax
<a name="aws-properties-codebuild-project-logsconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-logsconfig-syntax.json"></a>

```
{
  "[CloudWatchLogs](#cfn-codebuild-project-logsconfig-cloudwatchlogs)" : CloudWatchLogsConfig,
  "[S3Logs](#cfn-codebuild-project-logsconfig-s3logs)" : S3LogsConfig
}
```

### YAML
<a name="aws-properties-codebuild-project-logsconfig-syntax.yaml"></a>

```
  [CloudWatchLogs](#cfn-codebuild-project-logsconfig-cloudwatchlogs): 
    CloudWatchLogsConfig
  [S3Logs](#cfn-codebuild-project-logsconfig-s3logs): 
    S3LogsConfig
```

## Properties
<a name="aws-properties-codebuild-project-logsconfig-properties"></a>

`CloudWatchLogs`  <a name="cfn-codebuild-project-logsconfig-cloudwatchlogs"></a>
 Information about CloudWatch Logs for a build project. CloudWatch Logs are enabled by default.   
*Required*: No  
*Type*: [CloudWatchLogsConfig](aws-properties-codebuild-project-cloudwatchlogsconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Logs`  <a name="cfn-codebuild-project-logsconfig-s3logs"></a>
 Information about logs built to an S3 bucket for a build project. S3 logs are not enabled by default.   
*Required*: No  
*Type*: [S3LogsConfig](aws-properties-codebuild-project-s3logsconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-codebuild-project-logsconfig--seealso"></a>
+ [ LogsConfig](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_LogsConfig.html) in the *AWS CodeBuild API Reference*

# AWS::CodeBuild::Project ProjectBuildBatchConfig
<a name="aws-properties-codebuild-project-projectbuildbatchconfig"></a>

Contains configuration information about a batch build project.

## Syntax
<a name="aws-properties-codebuild-project-projectbuildbatchconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-projectbuildbatchconfig-syntax.json"></a>

```
{
  "[BatchReportMode](#cfn-codebuild-project-projectbuildbatchconfig-batchreportmode)" : String,
  "[CombineArtifacts](#cfn-codebuild-project-projectbuildbatchconfig-combineartifacts)" : Boolean,
  "[Restrictions](#cfn-codebuild-project-projectbuildbatchconfig-restrictions)" : BatchRestrictions,
  "[ServiceRole](#cfn-codebuild-project-projectbuildbatchconfig-servicerole)" : String,
  "[TimeoutInMins](#cfn-codebuild-project-projectbuildbatchconfig-timeoutinmins)" : Integer
}
```

### YAML
<a name="aws-properties-codebuild-project-projectbuildbatchconfig-syntax.yaml"></a>

```
  [BatchReportMode](#cfn-codebuild-project-projectbuildbatchconfig-batchreportmode): String
  [CombineArtifacts](#cfn-codebuild-project-projectbuildbatchconfig-combineartifacts): Boolean
  [Restrictions](#cfn-codebuild-project-projectbuildbatchconfig-restrictions): 
    BatchRestrictions
  [ServiceRole](#cfn-codebuild-project-projectbuildbatchconfig-servicerole): String
  [TimeoutInMins](#cfn-codebuild-project-projectbuildbatchconfig-timeoutinmins): Integer
```

## Properties
<a name="aws-properties-codebuild-project-projectbuildbatchconfig-properties"></a>

`BatchReportMode`  <a name="cfn-codebuild-project-projectbuildbatchconfig-batchreportmode"></a>
Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.    
REPORT\$1AGGREGATED\$1BATCH  
(Default) Aggregate all of the build statuses into a single status report.  
REPORT\$1INDIVIDUAL\$1BUILDS  
Send a separate status report for each individual build.
*Required*: No  
*Type*: String  
*Allowed values*: `REPORT_INDIVIDUAL_BUILDS | REPORT_AGGREGATED_BATCH`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CombineArtifacts`  <a name="cfn-codebuild-project-projectbuildbatchconfig-combineartifacts"></a>
Specifies if the build artifacts for the batch build should be combined into a single artifact location.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Restrictions`  <a name="cfn-codebuild-project-projectbuildbatchconfig-restrictions"></a>
A `BatchRestrictions` object that specifies the restrictions for the batch build.  
*Required*: No  
*Type*: [BatchRestrictions](aws-properties-codebuild-project-batchrestrictions.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServiceRole`  <a name="cfn-codebuild-project-projectbuildbatchconfig-servicerole"></a>
Specifies the service role ARN for the batch build project.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`TimeoutInMins`  <a name="cfn-codebuild-project-projectbuildbatchconfig-timeoutinmins"></a>
Specifies the maximum amount of time, in minutes, that the batch build must be completed in.  
*Required*: No  
*Type*: Integer  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project ProjectCache
<a name="aws-properties-codebuild-project-projectcache"></a>

`ProjectCache` is a property of the [AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies information about the cache for the build project. If `ProjectCache` is not specified, then both of its properties default to `NO_CACHE`.

## Syntax
<a name="aws-properties-codebuild-project-projectcache-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-projectcache-syntax.json"></a>

```
{
  "[CacheNamespace](#cfn-codebuild-project-projectcache-cachenamespace)" : String,
  "[Location](#cfn-codebuild-project-projectcache-location)" : String,
  "[Modes](#cfn-codebuild-project-projectcache-modes)" : [ String, ... ],
  "[Type](#cfn-codebuild-project-projectcache-type)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-projectcache-syntax.yaml"></a>

```
  [CacheNamespace](#cfn-codebuild-project-projectcache-cachenamespace): String
  [Location](#cfn-codebuild-project-projectcache-location): String
  [Modes](#cfn-codebuild-project-projectcache-modes): 
    - String
  [Type](#cfn-codebuild-project-projectcache-type): String
```

## Properties
<a name="aws-properties-codebuild-project-projectcache-properties"></a>

`CacheNamespace`  <a name="cfn-codebuild-project-projectcache-cachenamespace"></a>
Defines the scope of the cache. You can use this namespace to share a cache across multiple projects. For more information, see [Cache sharing between projects](https://docs.aws.amazon.com/codebuild/latest/userguide/caching-s3.html#caching-s3-sharing) in the *AWS CodeBuild User Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Location`  <a name="cfn-codebuild-project-projectcache-location"></a>
Information about the cache location:   
+ `NO_CACHE` or `LOCAL`: This value is ignored.
+ `S3`: This is the S3 bucket name/prefix.
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Modes`  <a name="cfn-codebuild-project-projectcache-modes"></a>
An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for `LOCAL` cache types.  
Possible values are:    
LOCAL\$1SOURCE\$1CACHE  
Caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored.   
LOCAL\$1DOCKER\$1LAYER\$1CACHE  
Caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network.   
+ You can use a Docker layer cache in the Linux environment only. 
+ The `privileged` flag must be set so that your project has the required Docker permissions. 
+ You should consider the security implications before you use a Docker layer cache.   
LOCAL\$1CUSTOM\$1CACHE  
Caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache:   
+ Only directories can be specified for caching. You cannot specify individual files. 
+ Symlinks are used to reference cached directories. 
+ Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. 
*Required*: No  
*Type*: Array of String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-project-projectcache-type"></a>
The type of cache used by the build project. Valid values include:  
+ `NO_CACHE`: The build project does not use any cache.
+ `S3`: The build project reads and writes from and to S3.
+ `LOCAL`: The build project stores a cache locally on a build host that is only available to that build host.
*Required*: Yes  
*Type*: String  
*Allowed values*: `NO_CACHE | S3 | LOCAL`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-codebuild-project-projectcache--seealso"></a>
+ [ ProjectCache](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ProjectCache.html) in the *AWS CodeBuild API Reference*

# AWS::CodeBuild::Project ProjectFileSystemLocation
<a name="aws-properties-codebuild-project-projectfilesystemlocation"></a>

 Information about a file system created by Amazon Elastic File System (EFS). For more information, see [What Is Amazon Elastic File System?](https://docs.aws.amazon.com/efs/latest/ug/whatisefs.html)

## Syntax
<a name="aws-properties-codebuild-project-projectfilesystemlocation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-projectfilesystemlocation-syntax.json"></a>

```
{
  "[Identifier](#cfn-codebuild-project-projectfilesystemlocation-identifier)" : String,
  "[Location](#cfn-codebuild-project-projectfilesystemlocation-location)" : String,
  "[MountOptions](#cfn-codebuild-project-projectfilesystemlocation-mountoptions)" : String,
  "[MountPoint](#cfn-codebuild-project-projectfilesystemlocation-mountpoint)" : String,
  "[Type](#cfn-codebuild-project-projectfilesystemlocation-type)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-projectfilesystemlocation-syntax.yaml"></a>

```
  [Identifier](#cfn-codebuild-project-projectfilesystemlocation-identifier): String
  [Location](#cfn-codebuild-project-projectfilesystemlocation-location): String
  [MountOptions](#cfn-codebuild-project-projectfilesystemlocation-mountoptions): String
  [MountPoint](#cfn-codebuild-project-projectfilesystemlocation-mountpoint): String
  [Type](#cfn-codebuild-project-projectfilesystemlocation-type): String
```

## Properties
<a name="aws-properties-codebuild-project-projectfilesystemlocation-properties"></a>

`Identifier`  <a name="cfn-codebuild-project-projectfilesystemlocation-identifier"></a>
The name used to access a file system created by Amazon EFS. CodeBuild creates an environment variable by appending the `identifier` in all capital letters to `CODEBUILD_`. For example, if you specify `my_efs` for `identifier`, a new environment variable is create named `CODEBUILD_MY_EFS`.   
 The `identifier` is used to mount your file system.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Location`  <a name="cfn-codebuild-project-projectfilesystemlocation-location"></a>
A string that specifies the location of the file system created by Amazon EFS. Its format is `efs-dns-name:/directory-path`. You can find the DNS name of file system when you view it in the Amazon EFS console. The directory path is a path to a directory in the file system that CodeBuild mounts. For example, if the DNS name of a file system is `fs-abcd1234.efs.us-west-2.amazonaws.com`, and its mount directory is `my-efs-mount-directory`, then the `location` is `fs-abcd1234.efs.us-west-2.amazonaws.com:/my-efs-mount-directory`.   
The directory path in the format `efs-dns-name:/directory-path` is optional. If you do not specify a directory path, the location is only the DNS name and CodeBuild mounts the entire file system.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MountOptions`  <a name="cfn-codebuild-project-projectfilesystemlocation-mountoptions"></a>
 The mount options for a file system created by Amazon EFS. The default mount options used by CodeBuild are `nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2`. For more information, see [Recommended NFS Mount Options](https://docs.aws.amazon.com/efs/latest/ug/mounting-fs-nfs-mount-settings.html).   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`MountPoint`  <a name="cfn-codebuild-project-projectfilesystemlocation-mountpoint"></a>
The location in the container where you mount the file system.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-project-projectfilesystemlocation-type"></a>
 The type of the file system. The one supported type is `EFS`.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `EFS`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project ProjectFleet
<a name="aws-properties-codebuild-project-projectfleet"></a>

Information about the compute fleet of the build project. For more information, see [Working with reserved capacity in AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/fleets.html).

## Syntax
<a name="aws-properties-codebuild-project-projectfleet-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-projectfleet-syntax.json"></a>

```
{
  "[FleetArn](#cfn-codebuild-project-projectfleet-fleetarn)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-projectfleet-syntax.yaml"></a>

```
  [FleetArn](#cfn-codebuild-project-projectfleet-fleetarn): String
```

## Properties
<a name="aws-properties-codebuild-project-projectfleet-properties"></a>

`FleetArn`  <a name="cfn-codebuild-project-projectfleet-fleetarn"></a>
Specifies the compute fleet ARN for the build project.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project ProjectSourceVersion
<a name="aws-properties-codebuild-project-projectsourceversion"></a>

 A source identifier and its corresponding version. 

## Syntax
<a name="aws-properties-codebuild-project-projectsourceversion-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-projectsourceversion-syntax.json"></a>

```
{
  "[SourceIdentifier](#cfn-codebuild-project-projectsourceversion-sourceidentifier)" : String,
  "[SourceVersion](#cfn-codebuild-project-projectsourceversion-sourceversion)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-projectsourceversion-syntax.yaml"></a>

```
  [SourceIdentifier](#cfn-codebuild-project-projectsourceversion-sourceidentifier): String
  [SourceVersion](#cfn-codebuild-project-projectsourceversion-sourceversion): String
```

## Properties
<a name="aws-properties-codebuild-project-projectsourceversion-properties"></a>

`SourceIdentifier`  <a name="cfn-codebuild-project-projectsourceversion-sourceidentifier"></a>
An identifier for a source in the build project. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceVersion`  <a name="cfn-codebuild-project-projectsourceversion-sourceversion"></a>
The source version for the corresponding source identifier. If specified, must be one of:  
+ For CodeCommit: the commit ID, branch, or Git tag to use.
+ For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format `pr/pull-request-ID` (for example, `pr/25`). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
+ For GitLab: the commit ID, branch, or Git tag to use.
+ For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
+ For Amazon S3: the version ID of the object that represents the build input ZIP file to use.
 For more information, see [Source Version Sample with CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the *AWS CodeBuild User Guide*.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project ProjectTriggers
<a name="aws-properties-codebuild-project-projecttriggers"></a>

`ProjectTriggers` is a property of the [AWS CodeBuild Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies webhooks that trigger an AWS CodeBuild build. 

**Note**  
The Webhook feature isn't available in AWS CloudFormation for GitHub Enterprise projects. Use the AWS CLI or AWS CodeBuild console to create the webhook.

## Syntax
<a name="aws-properties-codebuild-project-projecttriggers-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-projecttriggers-syntax.json"></a>

```
{
  "[BuildType](#cfn-codebuild-project-projecttriggers-buildtype)" : String,
  "[FilterGroups](#cfn-codebuild-project-projecttriggers-filtergroups)" : [ [ , ... ], ... ],
  "[ScopeConfiguration](#cfn-codebuild-project-projecttriggers-scopeconfiguration)" : ScopeConfiguration,
  "[Webhook](#cfn-codebuild-project-projecttriggers-webhook)" : Boolean
}
```

### YAML
<a name="aws-properties-codebuild-project-projecttriggers-syntax.yaml"></a>

```
  [BuildType](#cfn-codebuild-project-projecttriggers-buildtype): String
  [FilterGroups](#cfn-codebuild-project-projecttriggers-filtergroups): 
    - 
    - 
  [ScopeConfiguration](#cfn-codebuild-project-projecttriggers-scopeconfiguration): 
    ScopeConfiguration
  [Webhook](#cfn-codebuild-project-projecttriggers-webhook): Boolean
```

## Properties
<a name="aws-properties-codebuild-project-projecttriggers-properties"></a>

`BuildType`  <a name="cfn-codebuild-project-projecttriggers-buildtype"></a>
 Specifies the type of build this webhook will trigger. Allowed values are:     
BUILD  
A single build  
BUILD\$1BATCH  
A batch build
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`FilterGroups`  <a name="cfn-codebuild-project-projecttriggers-filtergroups"></a>
 A list of lists of `WebhookFilter` objects used to determine which webhook events are triggered. At least one `WebhookFilter` in the array must specify `EVENT` as its type.   
*Required*: No  
*Type*: Array of Array  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ScopeConfiguration`  <a name="cfn-codebuild-project-projecttriggers-scopeconfiguration"></a>
Contains configuration information about the scope for a webhook.  
*Required*: No  
*Type*: [ScopeConfiguration](aws-properties-codebuild-project-scopeconfiguration.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Webhook`  <a name="cfn-codebuild-project-projecttriggers-webhook"></a>
 Specifies whether or not to begin automatically rebuilding the source code every time a code change is pushed to the repository.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project RegistryCredential
<a name="aws-properties-codebuild-project-registrycredential"></a>

`RegistryCredential` is a property of the [AWS CodeBuild Project Environment ](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-environment.html) property type that specifies information about credentials that provide access to a private Docker registry. When this is set: 
+ `imagePullCredentialsType` must be set to `SERVICE_ROLE`. 
+  images cannot be curated or an Amazon ECR image.

 For more information, see [Private Registry with AWS Secrets Manager Sample for AWS CodeBuild](https://docs.aws.amazon.com/codebuild/latest/userguide/sample-private-registry.html). 

## Syntax
<a name="aws-properties-codebuild-project-registrycredential-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-registrycredential-syntax.json"></a>

```
{
  "[Credential](#cfn-codebuild-project-registrycredential-credential)" : String,
  "[CredentialProvider](#cfn-codebuild-project-registrycredential-credentialprovider)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-registrycredential-syntax.yaml"></a>

```
  [Credential](#cfn-codebuild-project-registrycredential-credential): String
  [CredentialProvider](#cfn-codebuild-project-registrycredential-credentialprovider): String
```

## Properties
<a name="aws-properties-codebuild-project-registrycredential-properties"></a>

`Credential`  <a name="cfn-codebuild-project-registrycredential-credential"></a>
 The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.   
 The `credential` can use the name of the credentials only if they exist in your current AWS Region. 
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`CredentialProvider`  <a name="cfn-codebuild-project-registrycredential-credentialprovider"></a>
 The service that created the credentials to access a private Docker registry. The valid value, SECRETS\$1MANAGER, is for AWS Secrets Manager.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `SECRETS_MANAGER`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-codebuild-project-registrycredential--seealso"></a>
+ [ RegistryCredential](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_RegistryCredential.html) in the *AWS CodeBuild API Reference*

# AWS::CodeBuild::Project S3LogsConfig
<a name="aws-properties-codebuild-project-s3logsconfig"></a>

`S3Logs` is a property of the [AWS CodeBuild Project LogsConfig ](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-logsconfig.html) property type that specifies settings for logs generated by an AWS CodeBuild build in an S3 bucket. 

## Syntax
<a name="aws-properties-codebuild-project-s3logsconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-s3logsconfig-syntax.json"></a>

```
{
  "[EncryptionDisabled](#cfn-codebuild-project-s3logsconfig-encryptiondisabled)" : Boolean,
  "[Location](#cfn-codebuild-project-s3logsconfig-location)" : String,
  "[Status](#cfn-codebuild-project-s3logsconfig-status)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-s3logsconfig-syntax.yaml"></a>

```
  [EncryptionDisabled](#cfn-codebuild-project-s3logsconfig-encryptiondisabled): Boolean
  [Location](#cfn-codebuild-project-s3logsconfig-location): String
  [Status](#cfn-codebuild-project-s3logsconfig-status): String
```

## Properties
<a name="aws-properties-codebuild-project-s3logsconfig-properties"></a>

`EncryptionDisabled`  <a name="cfn-codebuild-project-s3logsconfig-encryptiondisabled"></a>
 Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Location`  <a name="cfn-codebuild-project-s3logsconfig-location"></a>
 The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is `my-bucket`, and your path prefix is `build-log`, then acceptable formats are `my-bucket/build-log` or `arn:aws:s3:::my-bucket/build-log`.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Status`  <a name="cfn-codebuild-project-s3logsconfig-status"></a>
The current status of the S3 build logs. Valid values are:  
+ `ENABLED`: S3 build logs are enabled for this build project.
+ `DISABLED`: S3 build logs are not enabled for this build project.
*Required*: Yes  
*Type*: String  
*Allowed values*: `ENABLED | DISABLED`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-codebuild-project-s3logsconfig--seealso"></a>
+ [ S3LogsConfig](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_S3LogsConfig.html) in the *AWS CodeBuild API Reference*

# AWS::CodeBuild::Project ScopeConfiguration
<a name="aws-properties-codebuild-project-scopeconfiguration"></a>

Contains configuration information about the scope for a webhook.

## Syntax
<a name="aws-properties-codebuild-project-scopeconfiguration-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-scopeconfiguration-syntax.json"></a>

```
{
  "[Domain](#cfn-codebuild-project-scopeconfiguration-domain)" : String,
  "[Name](#cfn-codebuild-project-scopeconfiguration-name)" : String,
  "[Scope](#cfn-codebuild-project-scopeconfiguration-scope)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-scopeconfiguration-syntax.yaml"></a>

```
  [Domain](#cfn-codebuild-project-scopeconfiguration-domain): String
  [Name](#cfn-codebuild-project-scopeconfiguration-name): String
  [Scope](#cfn-codebuild-project-scopeconfiguration-scope): String
```

## Properties
<a name="aws-properties-codebuild-project-scopeconfiguration-properties"></a>

`Domain`  <a name="cfn-codebuild-project-scopeconfiguration-domain"></a>
The domain of the GitHub Enterprise organization or the GitLab Self Managed group. Note that this parameter is only required if your project's source type is GITHUB\$1ENTERPRISE or GITLAB\$1SELF\$1MANAGED.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-codebuild-project-scopeconfiguration-name"></a>
The name of either the enterprise or organization that will send webhook events to CodeBuild, depending on if the webhook is a global or organization webhook respectively.  
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Scope`  <a name="cfn-codebuild-project-scopeconfiguration-scope"></a>
The type of scope for a GitHub or GitLab webhook. The scope default is GITHUB\$1ORGANIZATION.  
*Required*: No  
*Type*: String  
*Allowed values*: `GITHUB_ORGANIZATION | GITHUB_GLOBAL | GITLAB_GROUP`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project Source
<a name="aws-properties-codebuild-project-source"></a>

`Source` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that specifies the source code settings for the project, such as the source code's repository type and location. 

## Syntax
<a name="aws-properties-codebuild-project-source-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-source-syntax.json"></a>

```
{
  "[Auth](#cfn-codebuild-project-source-auth)" : SourceAuth,
  "[BuildSpec](#cfn-codebuild-project-source-buildspec)" : String,
  "[BuildStatusConfig](#cfn-codebuild-project-source-buildstatusconfig)" : BuildStatusConfig,
  "[GitCloneDepth](#cfn-codebuild-project-source-gitclonedepth)" : Integer,
  "[GitSubmodulesConfig](#cfn-codebuild-project-source-gitsubmodulesconfig)" : GitSubmodulesConfig,
  "[InsecureSsl](#cfn-codebuild-project-source-insecuressl)" : Boolean,
  "[Location](#cfn-codebuild-project-source-location)" : String,
  "[ReportBuildStatus](#cfn-codebuild-project-source-reportbuildstatus)" : Boolean,
  "[SourceIdentifier](#cfn-codebuild-project-source-sourceidentifier)" : String,
  "[Type](#cfn-codebuild-project-source-type)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-source-syntax.yaml"></a>

```
  [Auth](#cfn-codebuild-project-source-auth): 
    SourceAuth
  [BuildSpec](#cfn-codebuild-project-source-buildspec): String
  [BuildStatusConfig](#cfn-codebuild-project-source-buildstatusconfig): 
    BuildStatusConfig
  [GitCloneDepth](#cfn-codebuild-project-source-gitclonedepth): Integer
  [GitSubmodulesConfig](#cfn-codebuild-project-source-gitsubmodulesconfig): 
    GitSubmodulesConfig
  [InsecureSsl](#cfn-codebuild-project-source-insecuressl): Boolean
  [Location](#cfn-codebuild-project-source-location): String
  [ReportBuildStatus](#cfn-codebuild-project-source-reportbuildstatus): Boolean
  [SourceIdentifier](#cfn-codebuild-project-source-sourceidentifier): String
  [Type](#cfn-codebuild-project-source-type): String
```

## Properties
<a name="aws-properties-codebuild-project-source-properties"></a>

`Auth`  <a name="cfn-codebuild-project-source-auth"></a>
Information about the authorization settings for AWS CodeBuild to access the source code to be built.  
*Required*: No  
*Type*: [SourceAuth](aws-properties-codebuild-project-sourceauth.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BuildSpec`  <a name="cfn-codebuild-project-source-buildspec"></a>
The build specification for the project. If this value is not provided, then the source code must contain a buildspec file named `buildspec.yml` at the root level. If this value is provided, it can be either a single string containing the entire build specification, or the path to an alternate buildspec file relative to the value of the built-in environment variable `CODEBUILD_SRC_DIR`. The alternate buildspec file can have a name other than `buildspec.yml`, for example `myspec.yml` or `build_spec_qa.yml` or similar. For more information, see the [Build Spec Reference](https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-example) in the *AWS CodeBuild User Guide*.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BuildStatusConfig`  <a name="cfn-codebuild-project-source-buildstatusconfig"></a>
Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is `GITHUB`, `GITHUB_ENTERPRISE`, or `BITBUCKET`.  
*Required*: No  
*Type*: [BuildStatusConfig](aws-properties-codebuild-project-buildstatusconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GitCloneDepth`  <a name="cfn-codebuild-project-source-gitclonedepth"></a>
 The depth of history to download. Minimum value is 0. If this value is 0, greater than 25, or not provided, then the full history is downloaded with each build project. If your source type is Amazon S3, this value is not supported.   
*Required*: No  
*Type*: Integer  
*Minimum*: `0`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`GitSubmodulesConfig`  <a name="cfn-codebuild-project-source-gitsubmodulesconfig"></a>
 Information about the Git submodules configuration for the build project.   
*Required*: No  
*Type*: [GitSubmodulesConfig](aws-properties-codebuild-project-gitsubmodulesconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`InsecureSsl`  <a name="cfn-codebuild-project-source-insecuressl"></a>
 This is used with GitHub Enterprise only. Set to true to ignore SSL warnings while connecting to your GitHub Enterprise project repository. The default value is `false`. `InsecureSsl` should be used for testing purposes only. It should not be used in a production environment.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Location`  <a name="cfn-codebuild-project-source-location"></a>
Information about the location of the source code to be built. Valid values include:  
+ For source code settings that are specified in the source action of a pipeline in CodePipeline, `location` should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.
+ For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, `https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name>`).
+ For source code in an Amazon S3 input bucket, one of the following. 
  + The path to the ZIP file that contains the source code (for example, `<bucket-name>/<path>/<object-name>.zip`). 
  + The path to the folder that contains the source code (for example, `<bucket-name>/<path-to-source-code>/<folder>/`). 
+ For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub **Authorize application** page, for **Organization access**, choose **Request access** next to each repository you want to allow AWS CodeBuild to have access to, and then choose **Authorize application**. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the `source` object, set the `auth` object's `type` value to `OAUTH`.
+ For source code in an GitLab or self-managed GitLab repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your GitLab account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitLab, on the Connections **Authorize application** page, choose **Authorize**. Then on the AWS CodeConnections**Create GitLab connection** page, choose **Connect to GitLab**. (After you have connected to your GitLab account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to override the default connection and use this connection instead, set the `auth` object's `type` value to `CODECONNECTIONS` in the `source` object.
+ For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket **Confirm access to your account** page, choose **Grant access**. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the `source` object, set the `auth` object's `type` value to `OAUTH`.
 If you specify `CODEPIPELINE` for the `Type` property, don't specify this property. For all of the other types, you must specify `Location`.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ReportBuildStatus`  <a name="cfn-codebuild-project-source-reportbuildstatus"></a>
 Set to true to report the status of a build's start and finish to your source provider. This option is valid only when your source provider is GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket. If this is set and you use a different source provider, an `invalidInputException` is thrown.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`SourceIdentifier`  <a name="cfn-codebuild-project-source-sourceidentifier"></a>
An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-project-source-type"></a>
The type of repository that contains the source code to be built. Valid values include:  
+ `BITBUCKET`: The source code is in a Bitbucket repository.
+ `CODECOMMIT`: The source code is in an CodeCommit repository.
+ `CODEPIPELINE`: The source code settings are specified in the source action of a pipeline in CodePipeline.
+ `GITHUB`: The source code is in a GitHub repository.
+ `GITHUB_ENTERPRISE`: The source code is in a GitHub Enterprise Server repository.
+ `GITLAB`: The source code is in a GitLab repository.
+ `GITLAB_SELF_MANAGED`: The source code is in a self-managed GitLab repository.
+ `NO_SOURCE`: The project does not have input source code.
+ `S3`: The source code is in an Amazon S3 bucket.
*Required*: Yes  
*Type*: String  
*Allowed values*: `CODECOMMIT | CODEPIPELINE | GITHUB | GITLAB | GITLAB_SELF_MANAGED | S3 | BITBUCKET | GITHUB_ENTERPRISE | NO_SOURCE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project SourceAuth
<a name="aws-properties-codebuild-project-sourceauth"></a>

`SourceAuth` is a property of the [AWS CodeBuild Project Source ](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-source.html) property type that specifies authorization settings for AWS CodeBuild to access the source code to be built. 

## Syntax
<a name="aws-properties-codebuild-project-sourceauth-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-sourceauth-syntax.json"></a>

```
{
  "[Resource](#cfn-codebuild-project-sourceauth-resource)" : String,
  "[Type](#cfn-codebuild-project-sourceauth-type)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-sourceauth-syntax.yaml"></a>

```
  [Resource](#cfn-codebuild-project-sourceauth-resource): String
  [Type](#cfn-codebuild-project-sourceauth-type): String
```

## Properties
<a name="aws-properties-codebuild-project-sourceauth-properties"></a>

`Resource`  <a name="cfn-codebuild-project-sourceauth-resource"></a>
 The resource value that applies to the specified authorization type.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-project-sourceauth-type"></a>
The authorization type to use. Valid options are OAUTH, CODECONNECTIONS, or SECRETS\$1MANAGER.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `OAUTH | CODECONNECTIONS | SECRETS_MANAGER`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project Tag
<a name="aws-properties-codebuild-project-tag"></a>

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.

## Syntax
<a name="aws-properties-codebuild-project-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-tag-syntax.json"></a>

```
{
  "[Key](#cfn-codebuild-project-tag-key)" : String,
  "[Value](#cfn-codebuild-project-tag-value)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-tag-syntax.yaml"></a>

```
  [Key](#cfn-codebuild-project-tag-key): String
  [Value](#cfn-codebuild-project-tag-value): String
```

## Properties
<a name="aws-properties-codebuild-project-tag-properties"></a>

`Key`  <a name="cfn-codebuild-project-tag-key"></a>
The tag's key.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=@+\-]*)$`  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-codebuild-project-tag-value"></a>
The tag's value.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=@+\-]*)$`  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::Project VpcConfig
<a name="aws-properties-codebuild-project-vpcconfig"></a>

`VpcConfig` is a property of the [AWS::CodeBuild::Project](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codebuild-project.html) resource that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see [Use AWS CodeBuild with Amazon Virtual Private Cloud](https://docs.aws.amazon.com/codebuild/latest/userguide/vpc-support.html) in the *AWS CodeBuild User Guide*. 

## Syntax
<a name="aws-properties-codebuild-project-vpcconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-vpcconfig-syntax.json"></a>

```
{
  "[SecurityGroupIds](#cfn-codebuild-project-vpcconfig-securitygroupids)" : [ String, ... ],
  "[Subnets](#cfn-codebuild-project-vpcconfig-subnets)" : [ String, ... ],
  "[VpcId](#cfn-codebuild-project-vpcconfig-vpcid)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-vpcconfig-syntax.yaml"></a>

```
  [SecurityGroupIds](#cfn-codebuild-project-vpcconfig-securitygroupids): 
    - String
  [Subnets](#cfn-codebuild-project-vpcconfig-subnets): 
    - String
  [VpcId](#cfn-codebuild-project-vpcconfig-vpcid): String
```

## Properties
<a name="aws-properties-codebuild-project-vpcconfig-properties"></a>

`SecurityGroupIds`  <a name="cfn-codebuild-project-vpcconfig-securitygroupids"></a>
A list of one or more security groups IDs in your Amazon VPC. The maximum count is 5.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `5`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Subnets`  <a name="cfn-codebuild-project-vpcconfig-subnets"></a>
A list of one or more subnet IDs in your Amazon VPC. The maximum count is 16.  
*Required*: No  
*Type*: Array of String  
*Maximum*: `16`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VpcId`  <a name="cfn-codebuild-project-vpcconfig-vpcid"></a>
The ID of the Amazon VPC.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## See also
<a name="aws-properties-codebuild-project-vpcconfig--seealso"></a>
+ [ VpcConfig](https://docs.aws.amazon.com/codebuild/latest/APIReference/API_VpcConfig.html) in the *AWS CodeBuild API Reference*

# AWS::CodeBuild::Project WebhookFilter
<a name="aws-properties-codebuild-project-webhookfilter"></a>

`WebhookFilter` is a structure of the `FilterGroups` property on the [AWS CodeBuild Project ProjectTriggers](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-codebuild-project-projecttriggers.html) property type that specifies which webhooks trigger an AWS CodeBuild build.

**Note**  
The Webhook feature isn't available in AWS CloudFormation for GitHub Enterprise projects. Use the AWS CLI or AWS CodeBuild console to create the webhook.

## Syntax
<a name="aws-properties-codebuild-project-webhookfilter-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-project-webhookfilter-syntax.json"></a>

```
{
  "[ExcludeMatchedPattern](#cfn-codebuild-project-webhookfilter-excludematchedpattern)" : Boolean,
  "[Pattern](#cfn-codebuild-project-webhookfilter-pattern)" : String,
  "[Type](#cfn-codebuild-project-webhookfilter-type)" : String
}
```

### YAML
<a name="aws-properties-codebuild-project-webhookfilter-syntax.yaml"></a>

```
  [ExcludeMatchedPattern](#cfn-codebuild-project-webhookfilter-excludematchedpattern): Boolean
  [Pattern](#cfn-codebuild-project-webhookfilter-pattern): String
  [Type](#cfn-codebuild-project-webhookfilter-type): String
```

## Properties
<a name="aws-properties-codebuild-project-webhookfilter-properties"></a>

`ExcludeMatchedPattern`  <a name="cfn-codebuild-project-webhookfilter-excludematchedpattern"></a>
 Used to indicate that the `pattern` determines which webhook events do not trigger a build. If true, then a webhook event that does not match the `pattern` triggers a build. If false, then a webhook event that matches the `pattern` triggers a build.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Pattern`  <a name="cfn-codebuild-project-webhookfilter-pattern"></a>
 For a `WebHookFilter` that uses `EVENT` type, a comma-separated string that specifies one or more events. For example, the webhook filter `PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED` allows all push, pull request created, and pull request updated events to trigger a build.   
 For a `WebHookFilter` that uses any of the other filter types, a regular expression pattern. For example, a `WebHookFilter` that uses `HEAD_REF` for its `type` and the pattern `^refs/heads/` triggers a build when the head reference is a branch with a reference name `refs/heads/branch-name`.   
*Required*: Yes  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-project-webhookfilter-type"></a>
 The type of webhook filter. There are 11 webhook filter types: `EVENT`, `ACTOR_ACCOUNT_ID`, `HEAD_REF`, `BASE_REF`, `FILE_PATH`, `COMMIT_MESSAGE`, `TAG_NAME`, `RELEASE_NAME`, `REPOSITORY_NAME`, `ORGANIZATION_NAME`, and `WORKFLOW_NAME`.   
+  EVENT 
  +  A webhook event triggers a build when the provided `pattern` matches one of nine event types: `PUSH`, `PULL_REQUEST_CREATED`, `PULL_REQUEST_UPDATED`, `PULL_REQUEST_CLOSED`, `PULL_REQUEST_REOPENED`, `PULL_REQUEST_MERGED`, `RELEASED`, `PRERELEASED`, and `WORKFLOW_JOB_QUEUED`. The `EVENT` patterns are specified as a comma-separated string. For example, `PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED` filters all push, pull request created, and pull request updated events. 
**Note**  
 Types `PULL_REQUEST_REOPENED` and `WORKFLOW_JOB_QUEUED` work with GitHub and GitHub Enterprise only. Types `RELEASED` and `PRERELEASED` work with GitHub only.
+ ACTOR\$1ACCOUNT\$1ID
  +  A webhook event triggers a build when a GitHub, GitHub Enterprise, or Bitbucket account ID matches the regular expression `pattern`. 
+ HEAD\$1REF
  +  A webhook event triggers a build when the head reference matches the regular expression `pattern`. For example, `refs/heads/branch-name` and `refs/tags/tag-name`. 
**Note**  
 Works with GitHub and GitHub Enterprise push, GitHub and GitHub Enterprise pull request, Bitbucket push, and Bitbucket pull request events.
+ BASE\$1REF
  +  A webhook event triggers a build when the base reference matches the regular expression `pattern`. For example, `refs/heads/branch-name`. 
**Note**  
 Works with pull request events only. 
+ FILE\$1PATH
  +  A webhook triggers a build when the path of a changed file matches the regular expression `pattern`. 
**Note**  
 Works with push and pull request events only. 
+ COMMIT\$1MESSAGE
  + A webhook triggers a build when the head commit message matches the regular expression `pattern`.
**Note**  
 Works with push and pull request events only. 
+ TAG\$1NAME
  + A webhook triggers a build when the tag name of the release matches the regular expression `pattern`.
**Note**  
 Works with `RELEASED` and `PRERELEASED` events only. 
+ RELEASE\$1NAME
  + A webhook triggers a build when the release name matches the regular expression `pattern`.
**Note**  
 Works with `RELEASED` and `PRERELEASED` events only. 
+ REPOSITORY\$1NAME
  + A webhook triggers a build when the repository name matches the regular expression `pattern`.
**Note**  
 Works with GitHub global or organization webhooks only. 
+ ORGANIZATION\$1NAME
  + A webhook triggers a build when the organization name matches the regular expression `pattern`.
**Note**  
 Works with GitHub global webhooks only. 
+ WORKFLOW\$1NAME
  + A webhook triggers a build when the workflow name matches the regular expression `pattern`.
**Note**  
 Works with `WORKFLOW_JOB_QUEUED` events only. 
**Note**  
For CodeBuild-hosted Buildkite runner builds, WORKFLOW\$1NAME filters will filter by pipeline name.
*Required*: Yes  
*Type*: String  
*Allowed values*: `EVENT | BASE_REF | HEAD_REF | ACTOR_ACCOUNT_ID | FILE_PATH | COMMIT_MESSAGE | WORKFLOW_NAME | TAG_NAME | RELEASE_NAME | REPOSITORY_NAME | ORGANIZATION_NAME`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::ReportGroup
<a name="aws-resource-codebuild-reportgroup"></a>

Represents a report group. A report group contains a collection of reports. 

## Syntax
<a name="aws-resource-codebuild-reportgroup-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-codebuild-reportgroup-syntax.json"></a>

```
{
  "Type" : "AWS::CodeBuild::ReportGroup",
  "Properties" : {
      "[DeleteReports](#cfn-codebuild-reportgroup-deletereports)" : Boolean,
      "[ExportConfig](#cfn-codebuild-reportgroup-exportconfig)" : ReportExportConfig,
      "[Name](#cfn-codebuild-reportgroup-name)" : String,
      "[Tags](#cfn-codebuild-reportgroup-tags)" : [ Tag, ... ],
      "[Type](#cfn-codebuild-reportgroup-type)" : String
    }
}
```

### YAML
<a name="aws-resource-codebuild-reportgroup-syntax.yaml"></a>

```
Type: AWS::CodeBuild::ReportGroup
Properties:
  [DeleteReports](#cfn-codebuild-reportgroup-deletereports): Boolean
  [ExportConfig](#cfn-codebuild-reportgroup-exportconfig): 
    ReportExportConfig
  [Name](#cfn-codebuild-reportgroup-name): String
  [Tags](#cfn-codebuild-reportgroup-tags): 
    - Tag
  [Type](#cfn-codebuild-reportgroup-type): String
```

## Properties
<a name="aws-resource-codebuild-reportgroup-properties"></a>

`DeleteReports`  <a name="cfn-codebuild-reportgroup-deletereports"></a>
When deleting a report group, specifies if reports within the report group should be deleted.    
true  
Deletes any reports that belong to the report group before deleting the report group.   
false  
You must delete any reports in the report group. This is the default value. If you delete a report group that contains one or more reports, an exception is thrown. 
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ExportConfig`  <a name="cfn-codebuild-reportgroup-exportconfig"></a>
Information about the destination where the raw data of this `ReportGroup` is exported.   
*Required*: Yes  
*Type*: [ReportExportConfig](aws-properties-codebuild-reportgroup-reportexportconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Name`  <a name="cfn-codebuild-reportgroup-name"></a>
The name of the `ReportGroup`.   
*Required*: No  
*Type*: String  
*Minimum*: `2`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Tags`  <a name="cfn-codebuild-reportgroup-tags"></a>
A list of tag key and value pairs associated with this report group.   
These tags are available for use by AWS services that support AWS CodeBuild report group tags.  
*Required*: No  
*Type*: Array of [Tag](aws-properties-codebuild-reportgroup-tag.md)  
*Minimum*: `0`  
*Maximum*: `50`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Type`  <a name="cfn-codebuild-reportgroup-type"></a>
The type of the `ReportGroup`. This can be one of the following values:    
CODE\$1COVERAGE  
The report group contains code coverage reports.  
TEST  
The report group contains test reports.
*Required*: Yes  
*Type*: String  
*Allowed values*: `TEST | CODE_COVERAGE`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-codebuild-reportgroup-return-values"></a>

### Ref
<a name="aws-resource-codebuild-reportgroup-return-values-ref"></a>

When the logical ID of this resource is provided to the `Ref` intrinsic function, `Ref` returns the ARN of the AWS CodeBuild report group, such as `arn:aws:codebuild:region:123456789012:report-group/myReportGroupName`.

For more information about using the `Ref` function, see [Ref](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-ref.html).

### Fn::GetAtt
<a name="aws-resource-codebuild-reportgroup-return-values-fn--getatt"></a>

`Fn::GetAtt` returns a value for a specified attribute of this type. The following are the available attributes and sample return values. For more information about using `Fn::GetAtt`, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-codebuild-reportgroup-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The ARN of the AWS CodeBuild report group, such as `arn:aws:codebuild:region:123456789012:report-group/myReportGroupName`. 

# AWS::CodeBuild::ReportGroup ReportExportConfig
<a name="aws-properties-codebuild-reportgroup-reportexportconfig"></a>

 Information about the location where the run of a report is exported. 

## Syntax
<a name="aws-properties-codebuild-reportgroup-reportexportconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-reportgroup-reportexportconfig-syntax.json"></a>

```
{
  "[ExportConfigType](#cfn-codebuild-reportgroup-reportexportconfig-exportconfigtype)" : String,
  "[S3Destination](#cfn-codebuild-reportgroup-reportexportconfig-s3destination)" : S3ReportExportConfig
}
```

### YAML
<a name="aws-properties-codebuild-reportgroup-reportexportconfig-syntax.yaml"></a>

```
  [ExportConfigType](#cfn-codebuild-reportgroup-reportexportconfig-exportconfigtype): String
  [S3Destination](#cfn-codebuild-reportgroup-reportexportconfig-s3destination): 
    S3ReportExportConfig
```

## Properties
<a name="aws-properties-codebuild-reportgroup-reportexportconfig-properties"></a>

`ExportConfigType`  <a name="cfn-codebuild-reportgroup-reportexportconfig-exportconfigtype"></a>
 The export configuration type. Valid values are:   
+ `S3`: The report results are exported to an S3 bucket. 
+ `NO_EXPORT`: The report results are not exported. 
*Required*: Yes  
*Type*: String  
*Allowed values*: `S3 | NO_EXPORT`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`S3Destination`  <a name="cfn-codebuild-reportgroup-reportexportconfig-s3destination"></a>
 A `S3ReportExportConfig` object that contains information about the S3 bucket where the run of a report is exported.   
*Required*: No  
*Type*: [S3ReportExportConfig](aws-properties-codebuild-reportgroup-s3reportexportconfig.md)  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::ReportGroup S3ReportExportConfig
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig"></a>

 Information about the S3 bucket where the raw data of a report are exported. 

## Syntax
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig-syntax.json"></a>

```
{
  "[Bucket](#cfn-codebuild-reportgroup-s3reportexportconfig-bucket)" : String,
  "[BucketOwner](#cfn-codebuild-reportgroup-s3reportexportconfig-bucketowner)" : String,
  "[EncryptionDisabled](#cfn-codebuild-reportgroup-s3reportexportconfig-encryptiondisabled)" : Boolean,
  "[EncryptionKey](#cfn-codebuild-reportgroup-s3reportexportconfig-encryptionkey)" : String,
  "[Packaging](#cfn-codebuild-reportgroup-s3reportexportconfig-packaging)" : String,
  "[Path](#cfn-codebuild-reportgroup-s3reportexportconfig-path)" : String
}
```

### YAML
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig-syntax.yaml"></a>

```
  [Bucket](#cfn-codebuild-reportgroup-s3reportexportconfig-bucket): String
  [BucketOwner](#cfn-codebuild-reportgroup-s3reportexportconfig-bucketowner): String
  [EncryptionDisabled](#cfn-codebuild-reportgroup-s3reportexportconfig-encryptiondisabled): Boolean
  [EncryptionKey](#cfn-codebuild-reportgroup-s3reportexportconfig-encryptionkey): String
  [Packaging](#cfn-codebuild-reportgroup-s3reportexportconfig-packaging): String
  [Path](#cfn-codebuild-reportgroup-s3reportexportconfig-path): String
```

## Properties
<a name="aws-properties-codebuild-reportgroup-s3reportexportconfig-properties"></a>

`Bucket`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-bucket"></a>
 The name of the S3 bucket where the raw data of a report are exported.   
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`BucketOwner`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-bucketowner"></a>
The AWS account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.  
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionDisabled`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-encryptiondisabled"></a>
 A boolean value that specifies if the results of a report are encrypted.   
*Required*: No  
*Type*: Boolean  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`EncryptionKey`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-encryptionkey"></a>
 The encryption key for the report's encrypted raw data.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Packaging`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-packaging"></a>
 The type of build output artifact to create. Valid values include:   
+ `NONE`: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified. 
+ `ZIP`: CodeBuild creates a ZIP file with the raw data in the output bucket. 
*Required*: No  
*Type*: String  
*Allowed values*: `ZIP | NONE`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Path`  <a name="cfn-codebuild-reportgroup-s3reportexportconfig-path"></a>
 The path to the exported report's raw data results.   
*Required*: No  
*Type*: String  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::ReportGroup Tag
<a name="aws-properties-codebuild-reportgroup-tag"></a>

A tag, consisting of a key and a value.

This tag is available for use by AWS services that support tags in AWS CodeBuild.

## Syntax
<a name="aws-properties-codebuild-reportgroup-tag-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-codebuild-reportgroup-tag-syntax.json"></a>

```
{
  "[Key](#cfn-codebuild-reportgroup-tag-key)" : String,
  "[Value](#cfn-codebuild-reportgroup-tag-value)" : String
}
```

### YAML
<a name="aws-properties-codebuild-reportgroup-tag-syntax.yaml"></a>

```
  [Key](#cfn-codebuild-reportgroup-tag-key): String
  [Value](#cfn-codebuild-reportgroup-tag-value): String
```

## Properties
<a name="aws-properties-codebuild-reportgroup-tag-properties"></a>

`Key`  <a name="cfn-codebuild-reportgroup-tag-key"></a>
The tag's key.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=@+\-]*)$`  
*Minimum*: `1`  
*Maximum*: `127`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Value`  <a name="cfn-codebuild-reportgroup-tag-value"></a>
The tag's value.  
*Required*: Yes  
*Type*: String  
*Pattern*: `^([\p{L}\p{Z}\p{N}_.:/=@+\-]*)$`  
*Minimum*: `0`  
*Maximum*: `255`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

# AWS::CodeBuild::SourceCredential
<a name="aws-resource-codebuild-sourcecredential"></a>

 Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository. We strongly recommend that you use AWS Secrets Manager to store your credentials. If you use Secrets Manager, you must have secrets in your secrets manager. For more information, see [ Using Dynamic References to Specify Template Values](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/dynamic-references.html#dynamic-references-secretsmanager). 

**Important**  
 For security purposes, do not use plain text in your CloudFormation template to store your credentials. 

## Syntax
<a name="aws-resource-codebuild-sourcecredential-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-codebuild-sourcecredential-syntax.json"></a>

```
{
  "Type" : "AWS::CodeBuild::SourceCredential",
  "Properties" : {
      "[AuthType](#cfn-codebuild-sourcecredential-authtype)" : String,
      "[ServerType](#cfn-codebuild-sourcecredential-servertype)" : String,
      "[Token](#cfn-codebuild-sourcecredential-token)" : String,
      "[Username](#cfn-codebuild-sourcecredential-username)" : String
    }
}
```

### YAML
<a name="aws-resource-codebuild-sourcecredential-syntax.yaml"></a>

```
Type: AWS::CodeBuild::SourceCredential
Properties:
  [AuthType](#cfn-codebuild-sourcecredential-authtype): String
  [ServerType](#cfn-codebuild-sourcecredential-servertype): String
  [Token](#cfn-codebuild-sourcecredential-token): String
  [Username](#cfn-codebuild-sourcecredential-username): String
```

## Properties
<a name="aws-resource-codebuild-sourcecredential-properties"></a>

`AuthType`  <a name="cfn-codebuild-sourcecredential-authtype"></a>
 The type of authentication used by the credentials. Valid options are OAUTH, BASIC\$1AUTH, PERSONAL\$1ACCESS\$1TOKEN, CODECONNECTIONS, or SECRETS\$1MANAGER.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `OAUTH | BASIC_AUTH | PERSONAL_ACCESS_TOKEN | CODECONNECTIONS | SECRETS_MANAGER`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ServerType`  <a name="cfn-codebuild-sourcecredential-servertype"></a>
 The type of source provider. The valid options are GITHUB, GITHUB\$1ENTERPRISE, GITLAB, GITLAB\$1SELF\$1MANAGED, or BITBUCKET.   
*Required*: Yes  
*Type*: String  
*Allowed values*: `GITHUB | BITBUCKET | GITHUB_ENTERPRISE | GITLAB | GITLAB_SELF_MANAGED`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Token`  <a name="cfn-codebuild-sourcecredential-token"></a>
 For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is either the access token or the app password. For the `authType` CODECONNECTIONS, this is the `connectionArn`. For the `authType` SECRETS\$1MANAGER, this is the `secretArn`.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Username`  <a name="cfn-codebuild-sourcecredential-username"></a>
 The Bitbucket username when the `authType` is BASIC\$1AUTH. This parameter is not valid for other types of source providers or connections.   
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [No interruption](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

## Examples
<a name="aws-resource-codebuild-sourcecredential--examples"></a>

**Topics**
+ [Create Bitbucket source credentials using AWS Secrets Manager](#aws-resource-codebuild-sourcecredential--examples--Create_Bitbucket_source_credentials_using)
+ [Create GitHub Enterprise source credentials using AWS Secrets Manager](#aws-resource-codebuild-sourcecredential--examples--Create_GitHub_Enterprise_source_credentials_using)
+ [Create GitHub source credentials using AWS Secrets Manager](#aws-resource-codebuild-sourcecredential--examples--Create_GitHub_source_credentials_using)
+ [Import source credentials for Bitbucket](#aws-resource-codebuild-sourcecredential--examples--Import_source_credentials_for_Bitbucket)
+ [Import source credentials for Github](#aws-resource-codebuild-sourcecredential--examples--Import_source_credentials_for_Github)

### Create Bitbucket source credentials using AWS Secrets Manager
<a name="aws-resource-codebuild-sourcecredential--examples--Create_Bitbucket_source_credentials_using"></a>

#### YAML
<a name="aws-resource-codebuild-sourcecredential--examples--Create_Bitbucket_source_credentials_using--yaml"></a>

```
CodeBuildSourceCredential:
  Type: 'AWS::CodeBuild::SourceCredential'
  Properties:
    Token: '{{resolve:secretsmanager:bitbucket:SecretString:token}}'
    ServerType: BITBUCKET
    Username: '{{resolve:secretsmanager:bitbucket:SecretString:username}}'
    AuthType: BASIC_AUTH
```

#### JSON
<a name="aws-resource-codebuild-sourcecredential--examples--Create_Bitbucket_source_credentials_using--json"></a>

```
{
   "CodeBuildSourceCredential": {
      "Type": "AWS::CodeBuild::SourceCredential",
      "Properties": {
         "Token": "{{resolve:secretsmanager:bitbucket:SecretString:token}}",
         "ServerType": "BITBUCKET",
         "Username": "{{resolve:secretsmanager:bitbucket:SecretString:username}}",
         "AuthType": "BASIC_AUTH"
      }
   }
}
```

### Create GitHub Enterprise source credentials using AWS Secrets Manager
<a name="aws-resource-codebuild-sourcecredential--examples--Create_GitHub_Enterprise_source_credentials_using"></a>

#### YAML
<a name="aws-resource-codebuild-sourcecredential--examples--Create_GitHub_Enterprise_source_credentials_using--yaml"></a>

```
Resources:
  CodeBuildSourceCredential:
    Type: 'AWS::CodeBuild::SourceCredential'
    Properties:
      Token: '{{resolve:secretsmanager:github_enterprise:SecretString:token}}'
      ServerType: GITHUB_ENTERPRISE
      AuthType: PERSONAL_ACCESS_TOKEN
```

#### JSON
<a name="aws-resource-codebuild-sourcecredential--examples--Create_GitHub_Enterprise_source_credentials_using--json"></a>

```
{
   "Resources": {
      "CodeBuildSourceCredential": {
         "Type": "AWS::CodeBuild::SourceCredential",
         "Properties": {
            "Token": "{{resolve:secretsmanager:github_enterprise:SecretString:token}}",
            "ServerType": "GITHUB_ENTERPRISE",
            "AuthType": "PERSONAL_ACCESS_TOKEN"
         }
      }
   }
}
```

### Create GitHub source credentials using AWS Secrets Manager
<a name="aws-resource-codebuild-sourcecredential--examples--Create_GitHub_source_credentials_using"></a>

#### YAML
<a name="aws-resource-codebuild-sourcecredential--examples--Create_GitHub_source_credentials_using--yaml"></a>

```
Resources:
  CodeBuildSourceCredential:
    Type: 'AWS::CodeBuild::SourceCredential'
    Properties:
      Token: '{{resolve:secretsmanager:github:SecretString:token}}'
      ServerType: GITHUB
      AuthType: PERSONAL_ACCESS_TOKEN
```

#### JSON
<a name="aws-resource-codebuild-sourcecredential--examples--Create_GitHub_source_credentials_using--json"></a>

```
{
   "Resources": {
      "CodeBuildSourceCredential": {
         "Type": "AWS::CodeBuild::SourceCredential",
         "Properties": {
            "Token": "{{resolve:secretsmanager:github:SecretString:token}}",
            "ServerType": "GITHUB",
            "AuthType": "PERSONAL_ACCESS_TOKEN"
         }
      }
   }
}
```

### Import source credentials for Bitbucket
<a name="aws-resource-codebuild-sourcecredential--examples--Import_source_credentials_for_Bitbucket"></a>

#### YAML
<a name="aws-resource-codebuild-sourcecredential--examples--Import_source_credentials_for_Bitbucket--yaml"></a>

```
Resources:
  MySourceCreds:
    Type: 'AWS::CodeBuild::SourceCredential'
    Properties:
      Token: '{{resolve:secretsmanager:bitbucket:SecretString:token}}'
      ServerType: BITBUCKET
      Username: '{{resolve:secretsmanager:bitbucket:SecretString:username}}'
      AuthType: BASIC_AUTH
  MyProject:
    Type: 'AWS::CodeBuild::Project'
    Properties:
      Name: myProjectName
      Description: A description about my project
      ServiceRole: testServiceRoleArn
      Artifacts:
        Type: NO_ARTIFACTS
      Environment:
        Type: LINUX_CONTAINER
        ComputeType: BUILD_GENERAL1_SMALL
        Image: 'aws/codebuild/standard:5.0'
      Source:
        Type: BITBUCKET
        Location: 'your-bitbucket-repo-url'
    DependsOn: MySourceCreds
```

#### JSON
<a name="aws-resource-codebuild-sourcecredential--examples--Import_source_credentials_for_Bitbucket--json"></a>

```
{
    "Resources": {
        "MySourceCreds": {
            "Type": "AWS::CodeBuild::SourceCredential",
            "Properties": {
                "Token": "{{resolve:secretsmanager:bitbucket:SecretString:token}}",
                "ServerType": "BITBUCKET",
                "Username": "{{resolve:secretsmanager:bitbucket:SecretString:username}}",
                "AuthType": "BASIC_AUTH"
            }
        },
        "MyProject": {
            "Type": "AWS::CodeBuild::Project",
            "Properties": {
                "Name": "myProjectName",
                "Description": "A description about my project",
                "ServiceRole": "testServiceRoleAr",
                "Artifacts": {
                    "Type": "NO_ARTIFACTS"
                },
                "Environment": {
                    "Type": "LINUX_CONTAINER",
                    "ComputeType": "BUILD_GENERAL1_SMALL",
                    "Image": "aws/codebuild/standard:5.0"
                },
                "Source": {
                    "Type": "BITBUCKET",
                    "Location": "your-bitbucket-repo-url"
                }
            },
            "DependsOn": "MySourceCreds"
        }
    }
}
```

### Import source credentials for Github
<a name="aws-resource-codebuild-sourcecredential--examples--Import_source_credentials_for_Github"></a>

#### YAML
<a name="aws-resource-codebuild-sourcecredential--examples--Import_source_credentials_for_Github--yaml"></a>

```
Resources:
  MySourceCreds:
    Type: 'AWS::CodeBuild::SourceCredential'
    Properties: 
      Token: '{{resolve:secretsmanager:github:SecretString:token}}'
      ServerType: GITHUB
      AuthType: PERSONAL_ACCESS_TOKEN
  MyProject:
    Type: 'AWS::CodeBuild::Project'
    Properties: 
      Name: myProjectName
      Description: A description about my project
      ServiceRole: testServiceRoleArn
      Artifacts:
        Type: NO_ARTIFACTS
      Environment:
        Type: LINUX_CONTAINER
        ComputeType: BUILD_GENERAL1_SMALL
        Image: 'aws/codebuild/standard:5.0'
      Source:
        Type: GITHUB
        Location: 'your-github-repo-url'
    DependsOn: MySourceCreds
```

#### JSON
<a name="aws-resource-codebuild-sourcecredential--examples--Import_source_credentials_for_Github--json"></a>

```
{
    "Resources": {
        "MySourceCreds": {
            "Type": "AWS::CodeBuild::SourceCredential",
            "Properties": {
                "Token": "{{resolve:secretsmanager:github:SecretString:token}}",
                "ServerType": "GITHUB",
                "AuthType": "PERSONAL_ACCESS_TOKEN"
            }
        },
        "MyProject": {
            "Type": "AWS::CodeBuild::Project",
            "Properties": {
                "Name": "myProjectName",
                "Description": "A description about my project",
                "ServiceRole": "testServiceRoleArn",
                "Artifacts": {
                    "Type": "NO_ARTIFACTS"
                },
                "Environment": {
                    "Type": "LINUX_CONTAINER",
                    "ComputeType": "BUILD_GENERAL1_SMALL",
                    "Image": "aws/codebuild/standard:5.0"
                },
                "Source": {
                    "Type": "GITHUB",
                    "Location": "your-github-repo-url"
                }
            },
            "DependsOn": "MySourceCreds"
        }
    }
}
```