AWS.Tools.CodeBuild.dll-Help.xml
|
<helpItems schema="maml">
<command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-CBBuildBatch</name> <description> <para>Calls the AWS CodeBuild BatchGetBuilds API operation.</para> </description> <verb>Get</verb> <noun>CBBuildBatch</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about one or more builds. </para> </description> <syntax> <syntaxItem> <name>Get-CBBuildBatch</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The IDs of the builds. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.BatchGetBuildsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.BatchGetBuildsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The IDs of the builds. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.BatchGetBuildsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.BatchGetBuildsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.BatchGetBuildsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.CodeBuild.Model.BatchGetBuildsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CBBuildBatch.html&tocid=Get-CBBuildBatch</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-CBBuildIdList</name> <description> <para>Calls the AWS CodeBuild ListBuilds API operation.</para> </description> <verb>Get</verb> <noun>CBBuildIdList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets a list of build IDs, with each build ID representing a single build.<br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para> </description> <syntax> <syntaxItem> <name>Get-CBBuildIdList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SortOrder</name> <description> <para>The order to list build IDs. Valid values include: - <code>ASCENDING</code>: List the build IDs in ascending order by build ID. - <code>DESCENDING</code>: List the build IDs in descending order by build ID. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SortOrderType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>nextToken</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Ids'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListBuildsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListBuildsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>nextToken</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Ids'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListBuildsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListBuildsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SortOrder</name> <description> <para>The order to list build IDs. Valid values include: - <code>ASCENDING</code>: List the build IDs in ascending order by build ID. - <code>DESCENDING</code>: List the build IDs in descending order by build ID. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SortOrderType</parameterValue> <type> <name>Amazon.CodeBuild.SortOrderType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String or Amazon.CodeBuild.Model.ListBuildsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of System.String objects. The service call response (type Amazon.CodeBuild.Model.ListBuildsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CBBuildIdList.html&tocid=Get-CBBuildIdList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-CBBuildIdListForProject</name> <description> <para>Calls the AWS CodeBuild ListBuildsForProject API operation.</para> </description> <verb>Get</verb> <noun>CBBuildIdListForProject</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets a list of build IDs for the specified build project, with each build ID representing a single build.<br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para> </description> <syntax> <syntaxItem> <name>Get-CBBuildIdListForProject</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SortOrder</name> <description> <para>The order to list build IDs. Valid values include: - <code>ASCENDING</code>: List the build IDs in ascending order by build ID. - <code>DESCENDING</code>: List the build IDs in descending order by build ID. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SortOrderType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>nextToken</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Ids'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListBuildsForProjectResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListBuildsForProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>nextToken</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Ids'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListBuildsForProjectResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListBuildsForProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SortOrder</name> <description> <para>The order to list build IDs. Valid values include: - <code>ASCENDING</code>: List the build IDs in ascending order by build ID. - <code>DESCENDING</code>: List the build IDs in descending order by build ID. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SortOrderType</parameterValue> <type> <name>Amazon.CodeBuild.SortOrderType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String or Amazon.CodeBuild.Model.ListBuildsForProjectResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of System.String objects. The service call response (type Amazon.CodeBuild.Model.ListBuildsForProjectResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CBBuildIdListForProject.html&tocid=Get-CBBuildIdListForProject</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-CBCuratedEnvironmentImageList</name> <description> <para>Calls the AWS CodeBuild ListCuratedEnvironmentImages API operation.</para> </description> <verb>Get</verb> <noun>CBCuratedEnvironmentImageList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about Docker images that are managed by AWS CodeBuild. </para> </description> <syntax> <syntaxItem> <name>Get-CBCuratedEnvironmentImageList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Platforms'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListCuratedEnvironmentImagesResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListCuratedEnvironmentImagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Platforms'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListCuratedEnvironmentImagesResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListCuratedEnvironmentImagesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.EnvironmentPlatform or Amazon.CodeBuild.Model.ListCuratedEnvironmentImagesResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.CodeBuild.Model.EnvironmentPlatform objects. The service call response (type Amazon.CodeBuild.Model.ListCuratedEnvironmentImagesResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CBCuratedEnvironmentImageList.html&tocid=Get-CBCuratedEnvironmentImageList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-CBProjectBatch</name> <description> <para>Calls the AWS CodeBuild BatchGetProjects API operation.</para> </description> <verb>Get</verb> <noun>CBProjectBatch</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets information about one or more build projects. </para> </description> <syntax> <syntaxItem> <name>Get-CBProjectBatch</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The names of the build projects. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.BatchGetProjectsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.BatchGetProjectsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The names of the build projects. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.BatchGetProjectsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.BatchGetProjectsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.BatchGetProjectsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.CodeBuild.Model.BatchGetProjectsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CBProjectBatch.html&tocid=Get-CBProjectBatch</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-CBProjectList</name> <description> <para>Calls the AWS CodeBuild ListProjects API operation.</para> </description> <verb>Get</verb> <noun>CBProjectList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Gets a list of build project names, with each build project name representing a single build project.<br /><br />This cmdlet automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. To disable autopagination, use -NoAutoIteration. </para> </description> <syntax> <syntaxItem> <name>Get-CBProjectList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SortBy</name> <description> <para>The criterion to be used to list build project names. Valid values include: - <code>CREATED_TIME</code>: List based on when each build project was created. - <code>LAST_MODIFIED_TIME</code>: List based on when information about each build project was last changed. - <code>NAME</code>: List based on each build project's name. Use <code>sortOrder</code> to specify in what order to list the build project names based on the preceding criteria. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ProjectSortByType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SortOrder</name> <description> <para>The order in which to list build projects. Valid values include: - <code>ASCENDING</code>: List in ascending order. - <code>DESCENDING</code>: List in descending order. Use <code>sortBy</code> to specify the criterion to be used to list build project names. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SortOrderType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>nextToken</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Projects'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListProjectsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListProjectsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NextToken</name> <description> <para>During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a <i>nextToken</i>. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned. <br /><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br />In order to manually control output pagination, use '-NextToken $null' for the first call and '-NextToken $AWSHistory.LastServiceResponse.NextToken' for subsequent calls. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>NoAutoIteration</name> <description> <para>By default the cmdlet will auto-iterate and retrieve all results to the pipeline by performing multiple service calls. If set, the cmdlet will retrieve only the next 'page' of results using the value of NextToken as the start point. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Projects'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListProjectsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListProjectsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SortBy</name> <description> <para>The criterion to be used to list build project names. Valid values include: - <code>CREATED_TIME</code>: List based on when each build project was created. - <code>LAST_MODIFIED_TIME</code>: List based on when information about each build project was last changed. - <code>NAME</code>: List based on each build project's name. Use <code>sortOrder</code> to specify in what order to list the build project names based on the preceding criteria. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ProjectSortByType</parameterValue> <type> <name>Amazon.CodeBuild.ProjectSortByType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SortOrder</name> <description> <para>The order in which to list build projects. Valid values include: - <code>ASCENDING</code>: List in ascending order. - <code>DESCENDING</code>: List in descending order. Use <code>sortBy</code> to specify the criterion to be used to list build project names. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SortOrderType</parameterValue> <type> <name>Amazon.CodeBuild.SortOrderType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String or Amazon.CodeBuild.Model.ListProjectsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of System.String objects. The service call response (type Amazon.CodeBuild.Model.ListProjectsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CBProjectList.html&tocid=Get-CBProjectList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Get-CBSourceCredentialList</name> <description> <para>Calls the AWS CodeBuild ListSourceCredentials API operation.</para> </description> <verb>Get</verb> <noun>CBSourceCredentialList</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Returns a list of <code>SourceCredentialsInfo</code> objects. </para> </description> <syntax> <syntaxItem> <name>Get-CBSourceCredentialList</name> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'SourceCredentialsInfos'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListSourceCredentialsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListSourceCredentialsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'SourceCredentialsInfos'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListSourceCredentialsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListSourceCredentialsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.SourceCredentialsInfo or Amazon.CodeBuild.Model.ListSourceCredentialsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a collection of Amazon.CodeBuild.Model.SourceCredentialsInfo objects. The service call response (type Amazon.CodeBuild.Model.ListSourceCredentialsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Get-CBSourceCredentialList.html&tocid=Get-CBSourceCredentialList</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Import-CBSourceCredential</name> <description> <para>Calls the AWS CodeBuild ImportSourceCredentials API operation.</para> </description> <verb>Import</verb> <noun>CBSourceCredential</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. </para> </description> <syntax> <syntaxItem> <name>Import-CBSourceCredential</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Token</name> <description> <para> For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AuthType</name> <description> <para> The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.AuthType</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerType</name> <description> <para> The source provider used for this project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ServerType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ShouldOverwrite</name> <description> <para> Set to <code>false</code> to prevent overwriting the repository source credentials. Set to <code>true</code> to overwrite the repository source credentials. The default value is <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Username</name> <description> <para> The Bitbucket username when the <code>authType</code> is BASIC_AUTH. This parameter is not valid for other types of source providers or connections. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ImportSourceCredentialsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ImportSourceCredentialsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Token parameter. The -PassThru parameter is deprecated, use -Select '^Token' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>AuthType</name> <description> <para> The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the AWS CodeBuild console. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.AuthType</parameterValue> <type> <name>Amazon.CodeBuild.AuthType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Token parameter. The -PassThru parameter is deprecated, use -Select '^Token' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ImportSourceCredentialsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ImportSourceCredentialsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServerType</name> <description> <para> The source provider used for this project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ServerType</parameterValue> <type> <name>Amazon.CodeBuild.ServerType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ShouldOverwrite</name> <description> <para> Set to <code>false</code> to prevent overwriting the repository source credentials. Set to <code>true</code> to overwrite the repository source credentials. The default value is <code>true</code>. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Token</name> <description> <para> For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Username</name> <description> <para> The Bitbucket username when the <code>authType</code> is BASIC_AUTH. This parameter is not valid for other types of source providers or connections. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String or Amazon.CodeBuild.Model.ImportSourceCredentialsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a System.String object. The service call response (type Amazon.CodeBuild.Model.ImportSourceCredentialsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Import-CBSourceCredential.html&tocid=Import-CBSourceCredential</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-CBProject</name> <description> <para>Calls the AWS CodeBuild CreateProject API operation.</para> </description> <verb>New</verb> <noun>CBProject</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Creates a build project. </para> </description> <syntax> <syntaxItem> <name>New-CBProject</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_ArtifactIdentifier</name> <description> <para> An identifier for this artifact definition. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BadgeEnabled</name> <description> <para>Set this to true to generate a publicly accessible URL for your project's build badge. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Buildspec</name> <description> <para>The build spec declaration to use for the builds in this build project. If this value is not specified, a build spec must be included along with the source code to be built. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Certificate</name> <description> <para>The certificate to use with this build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_ComputeType</name> <description> <para>Information about the compute resources the build project uses. Available values include: - <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds. - <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds. - <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type. - <code>BUILD_GENERAL1_2XLARGE</code>: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed. If you use <code>BUILD_GENERAL1_LARGE</code>: - For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. - For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build Environment Compute Types</a> in the <i>AWS CodeBuild User Guide.</i> </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ComputeType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredential_Credential</name> <description> <para> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The <code>credential</code> can use the name of the credentials only if they exist in your current region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredential_CredentialProvider</name> <description> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CredentialProviderType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Description</name> <description> <para>A description that makes the build project easy to identify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_EncryptionDisabled</name> <description> <para> 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_EncryptionDisabled</name> <description> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EncryptionKey</name> <description> <para>The AWS Key Management Service (AWS KMS) 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 <code>alias/<i>alias-name</i></code>). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_EnvironmentVariable</name> <description> <para>A set of environment variables to make available to builds for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.EnvironmentVariable[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GitSubmodulesConfig_FetchSubmodule</name> <description> <para> Set to true to fetch Git submodules for your AWS CodeBuild build project. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_GitCloneDepth</name> <description> <para>Information about the Git clone depth for the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_GroupName</name> <description> <para> The group name of the logs in Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Image</name> <description> <para>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: <code>registry/repository:tag</code>. For example, to specify an image with the tag "latest," use <code>registry/repository:latest</code>. - For an image digest: <code>registry/repository@digest</code>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <code>registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_ImagePullCredentialsType</name> <description> <para> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: - <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. - <code>SERVICE_ROLE</code> 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_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ImagePullCredentialsType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_InsecureSsl</name> <description> <para>Enable this flag to ignore SSL warnings while connecting to the project source code. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Location</name> <description> <para>Information about the build output artifact location: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Location</name> <description> <para>Information about the cache location: - <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored. - <code>S3</code>: This is the S3 bucket name/prefix. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Location</name> <description> <para> The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Location</name> <description> <para>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 AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value. - For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i></code>). - For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following. - The path to the ZIP file that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>). - The path to the folder that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>source-code</i>/<i>folder</i>/</code>). - For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. 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 <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to, and then choose <b>Authorize application</b>. (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 <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>. - For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. 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 <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (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 <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Mode</name> <description> <para> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. - <code>LOCAL_SOURCE_CACHE</code> mode 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. - <code>LOCAL_DOCKER_LAYER_CACHE</code> mode 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 <code>privileged</code> 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. - <code>LOCAL_CUSTOM_CACHE</code> mode 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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Name</name> <description> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, 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 <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. - If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in the root of the output bucket. - If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in <code>MyArtifacts/<i>build-ID</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_NamespaceType</name> <description> <para>Along with <code>path</code> and <code>name</code>, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact. - <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactNamespace</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_OverrideArtifactName</name> <description> <para> If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Packaging</name> <description> <para>The type of build output artifact to create: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>NONE</code>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified. - <code>ZIP</code>: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactPackaging</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Path</name> <description> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_PrivilegedMode</name> <description> <para>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 <code>false</code>. 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: <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> <code>- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"</code> If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>: <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> <code>- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>QueuedTimeoutInMinute</name> <description> <para> The number of minutes a build is allowed to be queued before it times out. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_ReportBuildStatus</name> <description> <para> 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, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Auth_Resource</name> <description> <para>The resource value that applies to the specified authorization type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondaryArtifact</name> <description> <para> An array of <code>ProjectArtifacts</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectArtifacts[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySource</name> <description> <para> An array of <code>ProjectSource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySourceVersion</name> <description> <para> An array of <code>ProjectSourceVersion</code> objects. If <code>secondarySourceVersions</code> is specified at the build level, then they take precedence over these <code>secondarySourceVersions</code> (at the project level). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSourceVersion[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_SecurityGroupId</name> <description> <para>A list of one or more security groups IDs in your Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServiceRole</name> <description> <para>The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_SourceIdentifier</name> <description> <para> An identifier for this project source. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceVersion</name> <description> <para> 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 AWS CodeCommit: the commit ID 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 <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). 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 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>AWS CodeBuild User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_Status</name> <description> <para>The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: - <code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project. - <code>DISABLED</code>: Amazon CloudWatch Logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Status</name> <description> <para>The current status of the S3 build logs. Valid values are: - <code>ENABLED</code>: S3 build logs are enabled for this build project. - <code>DISABLED</code>: S3 build logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_StreamName</name> <description> <para> The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_Subnet</name> <description> <para>A list of one or more subnet IDs in your Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Tag</name> <description> <para>A set of tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TimeoutInMinute</name> <description> <para>How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Type</name> <description> <para>The type of build output artifact. Valid values include: - <code>CODEPIPELINE</code>: The build project has build output generated through AWS CodePipeline. The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>. - <code>NO_ARTIFACTS</code>: The build project does not produce any build output. - <code>S3</code>: The build project stores build output in Amazon Simple Storage Service (Amazon S3). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactsType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Type</name> <description> <para>The type of cache used by the build project. Valid values include: - <code>NO_CACHE</code>: The build project does not use any cache. - <code>S3</code>: The build project reads and writes from and to S3. - <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CacheType</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Type</name> <description> <para>The type of build environment to use for related builds. - The environment type <code>ARM_CONTAINER</code> 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 (Sydney), and EU (Frankfurt). - The environment type <code>LINUX_CONTAINER</code> with compute type <code>build.general1.2xlarge</code> is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). - The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.EnvironmentType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Auth_Type</name> <description> <para> This data type is deprecated and is no longer accurate or used. The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceAuthType</parameterValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Type</name> <description> <para>The type of repository that contains the source code to be built. Valid values include: - <code>BITBUCKET</code>: The source code is in a Bitbucket repository. - <code>CODECOMMIT</code>: The source code is in an AWS CodeCommit repository. - <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline. - <code>GITHUB</code>: The source code is in a GitHub repository. - <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise repository. - <code>NO_SOURCE</code>: The project does not have input source code. - <code>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_VpcId</name> <description> <para>The ID of the Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Project'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.CreateProjectResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.CreateProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_ArtifactIdentifier</name> <description> <para> An identifier for this artifact definition. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_EncryptionDisabled</name> <description> <para> 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Location</name> <description> <para>Information about the build output artifact location: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Name</name> <description> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, 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 <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. - If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in the root of the output bucket. - If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in <code>MyArtifacts/<i>build-ID</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_NamespaceType</name> <description> <para>Along with <code>path</code> and <code>name</code>, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact. - <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactNamespace</parameterValue> <type> <name>Amazon.CodeBuild.ArtifactNamespace</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_OverrideArtifactName</name> <description> <para> If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Packaging</name> <description> <para>The type of build output artifact to create: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>NONE</code>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified. - <code>ZIP</code>: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactPackaging</parameterValue> <type> <name>Amazon.CodeBuild.ArtifactPackaging</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Path</name> <description> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Type</name> <description> <para>The type of build output artifact. Valid values include: - <code>CODEPIPELINE</code>: The build project has build output generated through AWS CodePipeline. The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>. - <code>NO_ARTIFACTS</code>: The build project does not produce any build output. - <code>S3</code>: The build project stores build output in Amazon Simple Storage Service (Amazon S3). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactsType</parameterValue> <type> <name>Amazon.CodeBuild.ArtifactsType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Auth_Resource</name> <description> <para>The resource value that applies to the specified authorization type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Auth_Type</name> <description> <para> This data type is deprecated and is no longer accurate or used. The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceAuthType</parameterValue> <type> <name>Amazon.CodeBuild.SourceAuthType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BadgeEnabled</name> <description> <para>Set this to true to generate a publicly accessible URL for your project's build badge. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Location</name> <description> <para>Information about the cache location: - <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored. - <code>S3</code>: This is the S3 bucket name/prefix. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Mode</name> <description> <para> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. - <code>LOCAL_SOURCE_CACHE</code> mode 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. - <code>LOCAL_DOCKER_LAYER_CACHE</code> mode 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 <code>privileged</code> 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. - <code>LOCAL_CUSTOM_CACHE</code> mode 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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Type</name> <description> <para>The type of cache used by the build project. Valid values include: - <code>NO_CACHE</code>: The build project does not use any cache. - <code>S3</code>: The build project reads and writes from and to S3. - <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CacheType</parameterValue> <type> <name>Amazon.CodeBuild.CacheType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_GroupName</name> <description> <para> The group name of the logs in Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_Status</name> <description> <para>The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: - <code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project. - <code>DISABLED</code>: Amazon CloudWatch Logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> <type> <name>Amazon.CodeBuild.LogsConfigStatusType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_StreamName</name> <description> <para> The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Description</name> <description> <para>A description that makes the build project easy to identify. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EncryptionKey</name> <description> <para>The AWS Key Management Service (AWS KMS) 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 <code>alias/<i>alias-name</i></code>). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Certificate</name> <description> <para>The certificate to use with this build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_ComputeType</name> <description> <para>Information about the compute resources the build project uses. Available values include: - <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds. - <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds. - <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type. - <code>BUILD_GENERAL1_2XLARGE</code>: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed. If you use <code>BUILD_GENERAL1_LARGE</code>: - For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. - For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build Environment Compute Types</a> in the <i>AWS CodeBuild User Guide.</i> </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ComputeType</parameterValue> <type> <name>Amazon.CodeBuild.ComputeType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_EnvironmentVariable</name> <description> <para>A set of environment variables to make available to builds for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.EnvironmentVariable[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.EnvironmentVariable[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Image</name> <description> <para>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: <code>registry/repository:tag</code>. For example, to specify an image with the tag "latest," use <code>registry/repository:latest</code>. - For an image digest: <code>registry/repository@digest</code>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <code>registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_ImagePullCredentialsType</name> <description> <para> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: - <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. - <code>SERVICE_ROLE</code> 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_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ImagePullCredentialsType</parameterValue> <type> <name>Amazon.CodeBuild.ImagePullCredentialsType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_PrivilegedMode</name> <description> <para>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 <code>false</code>. 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: <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> <code>- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"</code> If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>: <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> <code>- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Type</name> <description> <para>The type of build environment to use for related builds. - The environment type <code>ARM_CONTAINER</code> 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 (Sydney), and EU (Frankfurt). - The environment type <code>LINUX_CONTAINER</code> with compute type <code>build.general1.2xlarge</code> is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). - The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.EnvironmentType</parameterValue> <type> <name>Amazon.CodeBuild.EnvironmentType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GitSubmodulesConfig_FetchSubmodule</name> <description> <para> Set to true to fetch Git submodules for your AWS CodeBuild build project. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>QueuedTimeoutInMinute</name> <description> <para> The number of minutes a build is allowed to be queued before it times out. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredential_Credential</name> <description> <para> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The <code>credential</code> can use the name of the credentials only if they exist in your current region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredential_CredentialProvider</name> <description> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CredentialProviderType</parameterValue> <type> <name>Amazon.CodeBuild.CredentialProviderType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_EncryptionDisabled</name> <description> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Location</name> <description> <para> The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Status</name> <description> <para>The current status of the S3 build logs. Valid values are: - <code>ENABLED</code>: S3 build logs are enabled for this build project. - <code>DISABLED</code>: S3 build logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> <type> <name>Amazon.CodeBuild.LogsConfigStatusType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondaryArtifact</name> <description> <para> An array of <code>ProjectArtifacts</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectArtifacts[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.ProjectArtifacts[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySource</name> <description> <para> An array of <code>ProjectSource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSource[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.ProjectSource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySourceVersion</name> <description> <para> An array of <code>ProjectSourceVersion</code> objects. If <code>secondarySourceVersions</code> is specified at the build level, then they take precedence over these <code>secondarySourceVersions</code> (at the project level). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSourceVersion[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.ProjectSourceVersion[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Project'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.CreateProjectResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.CreateProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServiceRole</name> <description> <para>The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Buildspec</name> <description> <para>The build spec declaration to use for the builds in this build project. If this value is not specified, a build spec must be included along with the source code to be built. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_GitCloneDepth</name> <description> <para>Information about the Git clone depth for the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_InsecureSsl</name> <description> <para>Enable this flag to ignore SSL warnings while connecting to the project source code. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Location</name> <description> <para>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 AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value. - For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i></code>). - For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following. - The path to the ZIP file that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>). - The path to the folder that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>source-code</i>/<i>folder</i>/</code>). - For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. 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 <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to, and then choose <b>Authorize application</b>. (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 <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>. - For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. 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 <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (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 <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_ReportBuildStatus</name> <description> <para> 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, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_SourceIdentifier</name> <description> <para> An identifier for this project source. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Type</name> <description> <para>The type of repository that contains the source code to be built. Valid values include: - <code>BITBUCKET</code>: The source code is in a Bitbucket repository. - <code>CODECOMMIT</code>: The source code is in an AWS CodeCommit repository. - <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline. - <code>GITHUB</code>: The source code is in a GitHub repository. - <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise repository. - <code>NO_SOURCE</code>: The project does not have input source code. - <code>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceType</parameterValue> <type> <name>Amazon.CodeBuild.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceVersion</name> <description> <para> 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 AWS CodeCommit: the commit ID 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 <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). 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 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>AWS CodeBuild User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Tag</name> <description> <para>A set of tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.Tag[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TimeoutInMinute</name> <description> <para>How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_SecurityGroupId</name> <description> <para>A list of one or more security groups IDs in your Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_Subnet</name> <description> <para>A list of one or more subnet IDs in your Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_VpcId</name> <description> <para>The ID of the Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.Project or Amazon.CodeBuild.Model.CreateProjectResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.CodeBuild.Model.Project object. The service call response (type Amazon.CodeBuild.Model.CreateProjectResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-CBProject.html&tocid=New-CBProject</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>New-CBWebhook</name> <description> <para>Calls the AWS CodeBuild CreateWebhook API operation.</para> </description> <verb>New</verb> <noun>CBWebhook</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. <important><para> If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console">Change a Build Project's Settings</a>. </para></important> </para> </description> <syntax> <syntaxItem> <name>New-CBWebhook</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BranchFilter</name> <description> <para>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built. It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>FilterGroup</name> <description> <para> An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.WebhookFilter[][]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Webhook'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.CreateWebhookResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.CreateWebhookResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BranchFilter</name> <description> <para>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built. It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>FilterGroup</name> <description> <para> An array of arrays of <code>WebhookFilter</code> objects used to determine which webhooks are triggered. At least one <code>WebhookFilter</code> in the array must specify <code>EVENT</code> as its <code>type</code>. For a build to be triggered, at least one filter group in the <code>filterGroups</code> array must pass. For a filter group to pass, each of its filters must pass. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.WebhookFilter[][]</parameterValue> <type> <name>Amazon.CodeBuild.Model.WebhookFilter[][]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Webhook'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.CreateWebhookResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.CreateWebhookResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.Webhook or Amazon.CodeBuild.Model.CreateWebhookResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.CodeBuild.Model.Webhook object. The service call response (type Amazon.CodeBuild.Model.CreateWebhookResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=New-CBWebhook.html&tocid=New-CBWebhook</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-CBBuildBatch</name> <description> <para>Calls the AWS CodeBuild BatchDeleteBuilds API operation.</para> </description> <verb>Remove</verb> <noun>CBBuildBatch</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes one or more builds. </para> </description> <syntax> <syntaxItem> <name>Remove-CBBuildBatch</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The IDs of the builds to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.BatchDeleteBuildsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.BatchDeleteBuildsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The IDs of the builds to delete. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.BatchDeleteBuildsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.BatchDeleteBuildsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.BatchDeleteBuildsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.CodeBuild.Model.BatchDeleteBuildsResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-CBBuildBatch.html&tocid=Remove-CBBuildBatch</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-CBProject</name> <description> <para>Calls the AWS CodeBuild DeleteProject API operation.</para> </description> <verb>Remove</verb> <noun>CBProject</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a build project. When you delete a project, its builds are not deleted. </para> </description> <syntax> <syntaxItem> <name>Remove-CBProject</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.DeleteProjectResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.DeleteProjectResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.CodeBuild.Model.DeleteProjectResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.The service response (type Amazon.CodeBuild.Model.DeleteProjectResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-CBProject.html&tocid=Remove-CBProject</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-CBSourceCredential</name> <description> <para>Calls the AWS CodeBuild DeleteSourceCredentials API operation.</para> </description> <verb>Remove</verb> <noun>CBSourceCredential</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. </para> </description> <syntax> <syntaxItem> <name>Remove-CBSourceCredential</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Arn</name> <description> <para> The Amazon Resource Name (ARN) of the token. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.DeleteSourceCredentialsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.DeleteSourceCredentialsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Arn</name> <description> <para> The Amazon Resource Name (ARN) of the token. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Arn parameter. The -PassThru parameter is deprecated, use -Select '^Arn' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Arn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.DeleteSourceCredentialsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.DeleteSourceCredentialsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>System.String or Amazon.CodeBuild.Model.DeleteSourceCredentialsResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns a System.String object. The service call response (type Amazon.CodeBuild.Model.DeleteSourceCredentialsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-CBSourceCredential.html&tocid=Remove-CBSourceCredential</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Remove-CBWebhook</name> <description> <para>Calls the AWS CodeBuild DeleteWebhook API operation.</para> </description> <verb>Remove</verb> <noun>CBWebhook</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository. </para> </description> <syntax> <syntaxItem> <name>Remove-CBWebhook</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.DeleteWebhookResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.DeleteWebhookResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.CodeBuild.Model.DeleteWebhookResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.The service response (type Amazon.CodeBuild.Model.DeleteWebhookResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Remove-CBWebhook.html&tocid=Remove-CBWebhook</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Reset-CBProjectCache</name> <description> <para>Calls the AWS CodeBuild InvalidateProjectCache API operation.</para> </description> <verb>Reset</verb> <noun>CBProjectCache</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Resets the cache for a project. </para> </description> <syntax> <syntaxItem> <name>Reset-CBProjectCache</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild build project that the cache is reset for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.InvalidateProjectCacheResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild build project that the cache is reset for. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The cmdlet doesn't have a return value by default. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.InvalidateProjectCacheResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>None or Amazon.CodeBuild.Model.InvalidateProjectCacheResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet does not generate any output.The service response (type Amazon.CodeBuild.Model.InvalidateProjectCacheResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Reset-CBProjectCache.html&tocid=Reset-CBProjectCache</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Start-CBBuild</name> <description> <para>Calls the AWS CodeBuild StartBuild API operation.</para> </description> <verb>Start</verb> <noun>CBBuild</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Starts running a build. </para> </description> <syntax> <syntaxItem> <name>Start-CBBuild</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild build project to start running a build. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_ArtifactIdentifier</name> <description> <para> An identifier for this artifact definition. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BuildspecOverride</name> <description> <para>A build spec declaration that overrides, for this build only, the latest one already defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CertificateOverride</name> <description> <para>The name of a certificate for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ComputeTypeOverride</name> <description> <para>The name of a compute type for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ComputeType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredentialOverride_Credential</name> <description> <para> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The <code>credential</code> can use the name of the credentials only if they exist in your current region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredentialOverride_CredentialProvider</name> <description> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CredentialProviderType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_EncryptionDisabled</name> <description> <para> 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_EncryptionDisabled</name> <description> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EnvironmentTypeOverride</name> <description> <para>A container type for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.EnvironmentType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EnvironmentVariablesOverride</name> <description> <para>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.EnvironmentVariable[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GitSubmodulesConfigOverride_FetchSubmodule</name> <description> <para> Set to true to fetch Git submodules for your AWS CodeBuild build project. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GitCloneDepthOverride</name> <description> <para>The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_GroupName</name> <description> <para> The group name of the logs in Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>IdempotencyToken</name> <description> <para>A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ImageOverride</name> <description> <para>The name of an image for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ImagePullCredentialsTypeOverride</name> <description> <para> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: - <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. - <code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role. When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ImagePullCredentialsType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>InsecureSslOverride</name> <description> <para>Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Location</name> <description> <para>Information about the build output artifact location: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CacheOverride_Location</name> <description> <para>Information about the cache location: - <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored. - <code>S3</code>: This is the S3 bucket name/prefix. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Location</name> <description> <para> The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CacheOverride_Mode</name> <description> <para> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. - <code>LOCAL_SOURCE_CACHE</code> mode 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. - <code>LOCAL_DOCKER_LAYER_CACHE</code> mode 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 <code>privileged</code> 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. - <code>LOCAL_CUSTOM_CACHE</code> mode 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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Name</name> <description> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, 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 <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. - If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in the root of the output bucket. - If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in <code>MyArtifacts/<i>build-ID</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_NamespaceType</name> <description> <para>Along with <code>path</code> and <code>name</code>, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact. - <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactNamespace</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_OverrideArtifactName</name> <description> <para> If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Packaging</name> <description> <para>The type of build output artifact to create: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>NONE</code>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified. - <code>ZIP</code>: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactPackaging</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Path</name> <description> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PrivilegedModeOverride</name> <description> <para>Enable this flag to override privileged mode in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>QueuedTimeoutInMinutesOverride</name> <description> <para> The number of minutes a build is allowed to be queued before it times out. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ReportBuildStatusOverride</name> <description> <para> Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceAuthOverride_Resource</name> <description> <para>The resource value that applies to the specified authorization type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondaryArtifactsOverride</name> <description> <para> An array of <code>ProjectArtifacts</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectArtifacts[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySourcesOverride</name> <description> <para> An array of <code>ProjectSource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySourcesVersionOverride</name> <description> <para> An array of <code>ProjectSourceVersion</code> objects that specify one or more versions of the project's secondary sources to be used for this build only. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSourceVersion[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServiceRoleOverride</name> <description> <para>The name of a service role for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceLocationOverride</name> <description> <para>A location that overrides, for this build, the source location for the one defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceTypeOverride</name> <description> <para>A source input type, for this build, that overrides the source input defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceVersion</name> <description> <para>A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, must be one of: - For AWS CodeCommit: the commit ID 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 <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). 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 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>AWS CodeBuild User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_Status</name> <description> <para>The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: - <code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project. - <code>DISABLED</code>: Amazon CloudWatch Logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Status</name> <description> <para>The current status of the S3 build logs. Valid values are: - <code>ENABLED</code>: S3 build logs are enabled for this build project. - <code>DISABLED</code>: S3 build logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_StreamName</name> <description> <para> The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TimeoutInMinutesOverride</name> <description> <para>The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Type</name> <description> <para>The type of build output artifact. Valid values include: - <code>CODEPIPELINE</code>: The build project has build output generated through AWS CodePipeline. The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>. - <code>NO_ARTIFACTS</code>: The build project does not produce any build output. - <code>S3</code>: The build project stores build output in Amazon Simple Storage Service (Amazon S3). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactsType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CacheOverride_Type</name> <description> <para>The type of cache used by the build project. Valid values include: - <code>NO_CACHE</code>: The build project does not use any cache. - <code>S3</code>: The build project reads and writes from and to S3. - <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CacheType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceAuthOverride_Type</name> <description> <para> This data type is deprecated and is no longer accurate or used. The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceAuthType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Build'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.StartBuildResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.StartBuildResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_ArtifactIdentifier</name> <description> <para> An identifier for this artifact definition. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_EncryptionDisabled</name> <description> <para> 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Location</name> <description> <para>Information about the build output artifact location: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Name</name> <description> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, 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 <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. - If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in the root of the output bucket. - If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in <code>MyArtifacts/<i>build-ID</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_NamespaceType</name> <description> <para>Along with <code>path</code> and <code>name</code>, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact. - <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactNamespace</parameterValue> <type> <name>Amazon.CodeBuild.ArtifactNamespace</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_OverrideArtifactName</name> <description> <para> If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Packaging</name> <description> <para>The type of build output artifact to create: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>NONE</code>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified. - <code>ZIP</code>: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactPackaging</parameterValue> <type> <name>Amazon.CodeBuild.ArtifactPackaging</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Path</name> <description> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ArtifactsOverride_Type</name> <description> <para>The type of build output artifact. Valid values include: - <code>CODEPIPELINE</code>: The build project has build output generated through AWS CodePipeline. The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>. - <code>NO_ARTIFACTS</code>: The build project does not produce any build output. - <code>S3</code>: The build project stores build output in Amazon Simple Storage Service (Amazon S3). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactsType</parameterValue> <type> <name>Amazon.CodeBuild.ArtifactsType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BuildspecOverride</name> <description> <para>A build spec declaration that overrides, for this build only, the latest one already defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CacheOverride_Location</name> <description> <para>Information about the cache location: - <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored. - <code>S3</code>: This is the S3 bucket name/prefix. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CacheOverride_Mode</name> <description> <para> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. - <code>LOCAL_SOURCE_CACHE</code> mode 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. - <code>LOCAL_DOCKER_LAYER_CACHE</code> mode 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 <code>privileged</code> 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. - <code>LOCAL_CUSTOM_CACHE</code> mode 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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CacheOverride_Type</name> <description> <para>The type of cache used by the build project. Valid values include: - <code>NO_CACHE</code>: The build project does not use any cache. - <code>S3</code>: The build project reads and writes from and to S3. - <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CacheType</parameterValue> <type> <name>Amazon.CodeBuild.CacheType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CertificateOverride</name> <description> <para>The name of a certificate for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_GroupName</name> <description> <para> The group name of the logs in Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_Status</name> <description> <para>The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: - <code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project. - <code>DISABLED</code>: Amazon CloudWatch Logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> <type> <name>Amazon.CodeBuild.LogsConfigStatusType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_StreamName</name> <description> <para> The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ComputeTypeOverride</name> <description> <para>The name of a compute type for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ComputeType</parameterValue> <type> <name>Amazon.CodeBuild.ComputeType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EnvironmentTypeOverride</name> <description> <para>A container type for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.EnvironmentType</parameterValue> <type> <name>Amazon.CodeBuild.EnvironmentType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EnvironmentVariablesOverride</name> <description> <para>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.EnvironmentVariable[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.EnvironmentVariable[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GitCloneDepthOverride</name> <description> <para>The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GitSubmodulesConfigOverride_FetchSubmodule</name> <description> <para> Set to true to fetch Git submodules for your AWS CodeBuild build project. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>IdempotencyToken</name> <description> <para>A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ImageOverride</name> <description> <para>The name of an image for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ImagePullCredentialsTypeOverride</name> <description> <para> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: - <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. - <code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role. When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ImagePullCredentialsType</parameterValue> <type> <name>Amazon.CodeBuild.ImagePullCredentialsType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>InsecureSslOverride</name> <description> <para>Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PrivilegedModeOverride</name> <description> <para>Enable this flag to override privileged mode in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild build project to start running a build. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>QueuedTimeoutInMinutesOverride</name> <description> <para> The number of minutes a build is allowed to be queued before it times out. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredentialOverride_Credential</name> <description> <para> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The <code>credential</code> can use the name of the credentials only if they exist in your current region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredentialOverride_CredentialProvider</name> <description> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CredentialProviderType</parameterValue> <type> <name>Amazon.CodeBuild.CredentialProviderType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ReportBuildStatusOverride</name> <description> <para> Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_EncryptionDisabled</name> <description> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Location</name> <description> <para> The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Status</name> <description> <para>The current status of the S3 build logs. Valid values are: - <code>ENABLED</code>: S3 build logs are enabled for this build project. - <code>DISABLED</code>: S3 build logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> <type> <name>Amazon.CodeBuild.LogsConfigStatusType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondaryArtifactsOverride</name> <description> <para> An array of <code>ProjectArtifacts</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectArtifacts[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.ProjectArtifacts[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySourcesOverride</name> <description> <para> An array of <code>ProjectSource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSource[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.ProjectSource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySourcesVersionOverride</name> <description> <para> An array of <code>ProjectSourceVersion</code> objects that specify one or more versions of the project's secondary sources to be used for this build only. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSourceVersion[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.ProjectSourceVersion[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Build'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.StartBuildResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.StartBuildResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServiceRoleOverride</name> <description> <para>The name of a service role for this build that overrides the one specified in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceAuthOverride_Resource</name> <description> <para>The resource value that applies to the specified authorization type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceAuthOverride_Type</name> <description> <para> This data type is deprecated and is no longer accurate or used. The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceAuthType</parameterValue> <type> <name>Amazon.CodeBuild.SourceAuthType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceLocationOverride</name> <description> <para>A location that overrides, for this build, the source location for the one defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceTypeOverride</name> <description> <para>A source input type, for this build, that overrides the source input defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceType</parameterValue> <type> <name>Amazon.CodeBuild.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceVersion</name> <description> <para>A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, must be one of: - For AWS CodeCommit: the commit ID 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 <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). 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 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>AWS CodeBuild User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TimeoutInMinutesOverride</name> <description> <para>The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.Build or Amazon.CodeBuild.Model.StartBuildResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.CodeBuild.Model.Build object. The service call response (type Amazon.CodeBuild.Model.StartBuildResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Start-CBBuild.html&tocid=Start-CBBuild</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Stop-CBBuild</name> <description> <para>Calls the AWS CodeBuild StopBuild API operation.</para> </description> <verb>Stop</verb> <noun>CBBuild</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Attempts to stop running a build. </para> </description> <syntax> <syntaxItem> <name>Stop-CBBuild</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the build. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Build'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.StopBuildResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.StopBuildResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Id</name> <description> <para>The ID of the build. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Id parameter. The -PassThru parameter is deprecated, use -Select '^Id' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Build'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.StopBuildResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.StopBuildResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.Build or Amazon.CodeBuild.Model.StopBuildResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.CodeBuild.Model.Build object. The service call response (type Amazon.CodeBuild.Model.StopBuildResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Stop-CBBuild.html&tocid=Stop-CBBuild</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-CBProject</name> <description> <para>Calls the AWS CodeBuild UpdateProject API operation.</para> </description> <verb>Update</verb> <noun>CBProject</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Changes the settings of a build project. </para> </description> <syntax> <syntaxItem> <name>Update-CBProject</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the build project. You cannot change a build project's name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_ArtifactIdentifier</name> <description> <para> An identifier for this artifact definition. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BadgeEnabled</name> <description> <para>Set this to true to generate a publicly accessible URL for your project's build badge. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Buildspec</name> <description> <para>The build spec declaration to use for the builds in this build project. If this value is not specified, a build spec must be included along with the source code to be built. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Certificate</name> <description> <para>The certificate to use with this build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_ComputeType</name> <description> <para>Information about the compute resources the build project uses. Available values include: - <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds. - <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds. - <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type. - <code>BUILD_GENERAL1_2XLARGE</code>: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed. If you use <code>BUILD_GENERAL1_LARGE</code>: - For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. - For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build Environment Compute Types</a> in the <i>AWS CodeBuild User Guide.</i> </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ComputeType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredential_Credential</name> <description> <para> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The <code>credential</code> can use the name of the credentials only if they exist in your current region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredential_CredentialProvider</name> <description> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CredentialProviderType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Description</name> <description> <para>A new or replacement description of the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_EncryptionDisabled</name> <description> <para> 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_EncryptionDisabled</name> <description> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EncryptionKey</name> <description> <para>The AWS Key Management Service (AWS KMS) 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 <code>alias/<i>alias-name</i></code>). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_EnvironmentVariable</name> <description> <para>A set of environment variables to make available to builds for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.EnvironmentVariable[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GitSubmodulesConfig_FetchSubmodule</name> <description> <para> Set to true to fetch Git submodules for your AWS CodeBuild build project. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_GitCloneDepth</name> <description> <para>Information about the Git clone depth for the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_GroupName</name> <description> <para> The group name of the logs in Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Image</name> <description> <para>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: <code>registry/repository:tag</code>. For example, to specify an image with the tag "latest," use <code>registry/repository:latest</code>. - For an image digest: <code>registry/repository@digest</code>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <code>registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_ImagePullCredentialsType</name> <description> <para> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: - <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. - <code>SERVICE_ROLE</code> 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_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ImagePullCredentialsType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_InsecureSsl</name> <description> <para>Enable this flag to ignore SSL warnings while connecting to the project source code. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Location</name> <description> <para>Information about the build output artifact location: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Location</name> <description> <para>Information about the cache location: - <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored. - <code>S3</code>: This is the S3 bucket name/prefix. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Location</name> <description> <para> The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Location</name> <description> <para>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 AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value. - For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i></code>). - For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following. - The path to the ZIP file that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>). - The path to the folder that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>source-code</i>/<i>folder</i>/</code>). - For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. 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 <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to, and then choose <b>Authorize application</b>. (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 <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>. - For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. 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 <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (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 <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Mode</name> <description> <para> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. - <code>LOCAL_SOURCE_CACHE</code> mode 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. - <code>LOCAL_DOCKER_LAYER_CACHE</code> mode 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 <code>privileged</code> 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. - <code>LOCAL_CUSTOM_CACHE</code> mode 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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Name</name> <description> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, 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 <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. - If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in the root of the output bucket. - If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in <code>MyArtifacts/<i>build-ID</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_NamespaceType</name> <description> <para>Along with <code>path</code> and <code>name</code>, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact. - <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactNamespace</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_OverrideArtifactName</name> <description> <para> If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Packaging</name> <description> <para>The type of build output artifact to create: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>NONE</code>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified. - <code>ZIP</code>: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactPackaging</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Path</name> <description> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_PrivilegedMode</name> <description> <para>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 <code>false</code>. 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: <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> <code>- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"</code> If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>: <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> <code>- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>QueuedTimeoutInMinute</name> <description> <para> The number of minutes a build is allowed to be queued before it times out. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_ReportBuildStatus</name> <description> <para> 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, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Auth_Resource</name> <description> <para>The resource value that applies to the specified authorization type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondaryArtifact</name> <description> <para> An array of <code>ProjectSource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectArtifacts[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySource</name> <description> <para> An array of <code>ProjectSource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSource[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySourceVersion</name> <description> <para> An array of <code>ProjectSourceVersion</code> objects. If <code>secondarySourceVersions</code> is specified at the build level, then they take over these <code>secondarySourceVersions</code> (at the project level). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSourceVersion[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_SecurityGroupId</name> <description> <para>A list of one or more security groups IDs in your Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServiceRole</name> <description> <para>The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_SourceIdentifier</name> <description> <para> An identifier for this project source. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceVersion</name> <description> <para> 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 AWS CodeCommit: the commit ID 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 <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). 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 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>AWS CodeBuild User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_Status</name> <description> <para>The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: - <code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project. - <code>DISABLED</code>: Amazon CloudWatch Logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Status</name> <description> <para>The current status of the S3 build logs. Valid values are: - <code>ENABLED</code>: S3 build logs are enabled for this build project. - <code>DISABLED</code>: S3 build logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_StreamName</name> <description> <para> The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_Subnet</name> <description> <para>A list of one or more subnet IDs in your Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Tag</name> <description> <para>The replacement set of tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.Tag[]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TimeoutInMinute</name> <description> <para>The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Type</name> <description> <para>The type of build output artifact. Valid values include: - <code>CODEPIPELINE</code>: The build project has build output generated through AWS CodePipeline. The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>. - <code>NO_ARTIFACTS</code>: The build project does not produce any build output. - <code>S3</code>: The build project stores build output in Amazon Simple Storage Service (Amazon S3). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactsType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Type</name> <description> <para>The type of cache used by the build project. Valid values include: - <code>NO_CACHE</code>: The build project does not use any cache. - <code>S3</code>: The build project reads and writes from and to S3. - <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CacheType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Type</name> <description> <para>The type of build environment to use for related builds. - The environment type <code>ARM_CONTAINER</code> 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 (Sydney), and EU (Frankfurt). - The environment type <code>LINUX_CONTAINER</code> with compute type <code>build.general1.2xlarge</code> is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). - The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.EnvironmentType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Auth_Type</name> <description> <para> This data type is deprecated and is no longer accurate or used. The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceAuthType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Type</name> <description> <para>The type of repository that contains the source code to be built. Valid values include: - <code>BITBUCKET</code>: The source code is in a Bitbucket repository. - <code>CODECOMMIT</code>: The source code is in an AWS CodeCommit repository. - <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline. - <code>GITHUB</code>: The source code is in a GitHub repository. - <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise repository. - <code>NO_SOURCE</code>: The project does not have input source code. - <code>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceType</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_VpcId</name> <description> <para>The ID of the Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Project'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.UpdateProjectResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.UpdateProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_ArtifactIdentifier</name> <description> <para> An identifier for this artifact definition. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_EncryptionDisabled</name> <description> <para> 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Location</name> <description> <para>Information about the build output artifact location: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Name</name> <description> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, 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 <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, then the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. - If <code>path</code> is empty, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in the root of the output bucket. - If <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to "<code>/</code>", the output artifact is stored in <code>MyArtifacts/<i>build-ID</i></code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_NamespaceType</name> <description> <para>Along with <code>path</code> and <code>name</code>, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>BUILD_ID</code>: Include the build ID in the location of the build output artifact. - <code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>BUILD_ID</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in <code>MyArtifacts/<i>build-ID</i>/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactNamespace</parameterValue> <type> <name>Amazon.CodeBuild.ArtifactNamespace</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_OverrideArtifactName</name> <description> <para> If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec 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. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Packaging</name> <description> <para>The type of build output artifact to create: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, valid values include: - <code>NONE</code>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified. - <code>ZIP</code>: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactPackaging</parameterValue> <type> <name>Amazon.CodeBuild.ArtifactPackaging</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Path</name> <description> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that AWS CodeBuild uses to name and store the output artifact: - If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. - If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced. - If <code>type</code> is set to <code>S3</code>, this is the path to the output artifact. If <code>path</code> is not specified, <code>path</code> is not used. For example, if <code>path</code> is set to <code>MyArtifacts</code>, <code>namespaceType</code> is set to <code>NONE</code>, and <code>name</code> is set to <code>MyArtifact.zip</code>, the output artifact is stored in the output bucket at <code>MyArtifacts/MyArtifact.zip</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Artifacts_Type</name> <description> <para>The type of build output artifact. Valid values include: - <code>CODEPIPELINE</code>: The build project has build output generated through AWS CodePipeline. The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>. - <code>NO_ARTIFACTS</code>: The build project does not produce any build output. - <code>S3</code>: The build project stores build output in Amazon Simple Storage Service (Amazon S3). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ArtifactsType</parameterValue> <type> <name>Amazon.CodeBuild.ArtifactsType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Auth_Resource</name> <description> <para>The resource value that applies to the specified authorization type. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Auth_Type</name> <description> <para> This data type is deprecated and is no longer accurate or used. The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceAuthType</parameterValue> <type> <name>Amazon.CodeBuild.SourceAuthType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BadgeEnabled</name> <description> <para>Set this to true to generate a publicly accessible URL for your project's build badge. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Location</name> <description> <para>Information about the cache location: - <code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored. - <code>S3</code>: This is the S3 bucket name/prefix. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Mode</name> <description> <para> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. - <code>LOCAL_SOURCE_CACHE</code> mode 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. - <code>LOCAL_DOCKER_LAYER_CACHE</code> mode 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 <code>privileged</code> 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. - <code>LOCAL_CUSTOM_CACHE</code> mode 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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Cache_Type</name> <description> <para>The type of cache used by the build project. Valid values include: - <code>NO_CACHE</code>: The build project does not use any cache. - <code>S3</code>: The build project reads and writes from and to S3. - <code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CacheType</parameterValue> <type> <name>Amazon.CodeBuild.CacheType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_GroupName</name> <description> <para> The group name of the logs in Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_Status</name> <description> <para>The current status of the logs in Amazon CloudWatch Logs for a build project. Valid values are: - <code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project. - <code>DISABLED</code>: Amazon CloudWatch Logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> <type> <name>Amazon.CodeBuild.LogsConfigStatusType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>CloudWatchLogs_StreamName</name> <description> <para> The prefix of the stream name of the Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Description</name> <description> <para>A new or replacement description of the build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>EncryptionKey</name> <description> <para>The AWS Key Management Service (AWS KMS) 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 <code>alias/<i>alias-name</i></code>). </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Certificate</name> <description> <para>The certificate to use with this build project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_ComputeType</name> <description> <para>Information about the compute resources the build project uses. Available values include: - <code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds. - <code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds. - <code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type. - <code>BUILD_GENERAL1_2XLARGE</code>: Use up to 145 GB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed. If you use <code>BUILD_GENERAL1_LARGE</code>: - For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. - For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 255 GB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds. - For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-compute-types.html">Build Environment Compute Types</a> in the <i>AWS CodeBuild User Guide.</i> </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ComputeType</parameterValue> <type> <name>Amazon.CodeBuild.ComputeType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_EnvironmentVariable</name> <description> <para>A set of environment variables to make available to builds for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.EnvironmentVariable[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.EnvironmentVariable[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Image</name> <description> <para>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: <code>registry/repository:tag</code>. For example, to specify an image with the tag "latest," use <code>registry/repository:latest</code>. - For an image digest: <code>registry/repository@digest</code>. For example, to specify an image with the digest "sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf," use <code>registry/repository@sha256:cbbf2f9a99b47fc460d422812b6a5adff7dfee951d8fa2e4a98caa0382cfbdbf</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_ImagePullCredentialsType</name> <description> <para> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: - <code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. - <code>SERVICE_ROLE</code> 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_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.ImagePullCredentialsType</parameterValue> <type> <name>Amazon.CodeBuild.ImagePullCredentialsType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_PrivilegedMode</name> <description> <para>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 <code>false</code>. 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: <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> <code>- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"</code> If the operating system's base image is Alpine Linux and the previous command does not work, add the <code>-t</code> argument to <code>timeout</code>: <code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&amp;</code> <code>- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"</code> </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Environment_Type</name> <description> <para>The type of build environment to use for related builds. - The environment type <code>ARM_CONTAINER</code> 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 (Sydney), and EU (Frankfurt). - The environment type <code>LINUX_CONTAINER</code> with compute type <code>build.general1.2xlarge</code> is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney), China (Beijing), and China (Ningxia). - The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (N. Virginia), US West (Oregon), Canada (Central), EU (Ireland), EU (London), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Seoul), Asia Pacific (Singapore), Asia Pacific (Sydney) , China (Beijing), and China (Ningxia). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.EnvironmentType</parameterValue> <type> <name>Amazon.CodeBuild.EnvironmentType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>GitSubmodulesConfig_FetchSubmodule</name> <description> <para> Set to true to fetch Git submodules for your AWS CodeBuild build project. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>Name</name> <description> <para>The name of the build project. You cannot change a build project's name. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>QueuedTimeoutInMinute</name> <description> <para> The number of minutes a build is allowed to be queued before it times out. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredential_Credential</name> <description> <para> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. The <code>credential</code> can use the name of the credentials only if they exist in your current region. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RegistryCredential_CredentialProvider</name> <description> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.CredentialProviderType</parameterValue> <type> <name>Amazon.CodeBuild.CredentialProviderType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_EncryptionDisabled</name> <description> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Location</name> <description> <para> The ARN of an S3 bucket and the path prefix for S3 logs. If your Amazon S3 bucket name is <code>my-bucket</code>, and your path prefix is <code>build-log</code>, then acceptable formats are <code>my-bucket/build-log</code> or <code>arn:aws:s3:::my-bucket/build-log</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>S3Logs_Status</name> <description> <para>The current status of the S3 build logs. Valid values are: - <code>ENABLED</code>: S3 build logs are enabled for this build project. - <code>DISABLED</code>: S3 build logs are not enabled for this build project. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.LogsConfigStatusType</parameterValue> <type> <name>Amazon.CodeBuild.LogsConfigStatusType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondaryArtifact</name> <description> <para> An array of <code>ProjectSource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectArtifacts[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.ProjectArtifacts[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySource</name> <description> <para> An array of <code>ProjectSource</code> objects. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSource[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.ProjectSource[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SecondarySourceVersion</name> <description> <para> An array of <code>ProjectSourceVersion</code> objects. If <code>secondarySourceVersions</code> is specified at the build level, then they take over these <code>secondarySourceVersions</code> (at the project level). </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.ProjectSourceVersion[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.ProjectSourceVersion[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Project'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.UpdateProjectResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.UpdateProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>ServiceRole</name> <description> <para>The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Buildspec</name> <description> <para>The build spec declaration to use for the builds in this build project. If this value is not specified, a build spec must be included along with the source code to be built. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_GitCloneDepth</name> <description> <para>Information about the Git clone depth for the build project. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_InsecureSsl</name> <description> <para>Enable this flag to ignore SSL warnings while connecting to the project source code. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Location</name> <description> <para>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 AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value. - For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i></code>). - For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, one of the following. - The path to the ZIP file that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>). - The path to the folder that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>source-code</i>/<i>folder</i>/</code>). - For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. 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 <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to, and then choose <b>Authorize application</b>. (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 <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>. - For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. 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 <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (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 <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_ReportBuildStatus</name> <description> <para> 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, or Bitbucket. If this is set and you use a different source provider, an invalidInputException is thrown. The status of a build triggered by a webhook is always reported to your source provider. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_SourceIdentifier</name> <description> <para> An identifier for this project source. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Source_Type</name> <description> <para>The type of repository that contains the source code to be built. Valid values include: - <code>BITBUCKET</code>: The source code is in a Bitbucket repository. - <code>CODECOMMIT</code>: The source code is in an AWS CodeCommit repository. - <code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline. - <code>GITHUB</code>: The source code is in a GitHub repository. - <code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise repository. - <code>NO_SOURCE</code>: The project does not have input source code. - <code>S3</code>: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.SourceType</parameterValue> <type> <name>Amazon.CodeBuild.SourceType</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>SourceVersion</name> <description> <para> 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 AWS CodeCommit: the commit ID 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 <code>pr/pull-request-ID</code> (for example <code>pr/25</code>). 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 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 Simple Storage Service (Amazon S3): the version ID of the object that represents the build input ZIP file to use. If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html">Source Version Sample with CodeBuild</a> in the <i>AWS CodeBuild User Guide</i>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Tag</name> <description> <para>The replacement set of tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.Tag[]</parameterValue> <type> <name>Amazon.CodeBuild.Model.Tag[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>TimeoutInMinute</name> <description> <para>The replacement value in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. </para> </description> <parameterValue required="true" variableLength="false">System.Int32</parameterValue> <type> <name>System.Int32</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_SecurityGroupId</name> <description> <para>A list of one or more security groups IDs in your Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_Subnet</name> <description> <para>A list of one or more subnet IDs in your Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String[]</parameterValue> <type> <name>System.String[]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>VpcConfig_VpcId</name> <description> <para>The ID of the Amazon VPC. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.Project or Amazon.CodeBuild.Model.UpdateProjectResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.CodeBuild.Model.Project object. The service call response (type Amazon.CodeBuild.Model.UpdateProjectResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-CBProject.html&tocid=Update-CBProject</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> <command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10"> <details> <name>Update-CBWebhook</name> <description> <para>Calls the AWS CodeBuild UpdateWebhook API operation.</para> </description> <verb>Update</verb> <noun>CBWebhook</noun> <copyright> <para>&copy; Copyright 2012 - 2019 Amazon.com, Inc.or its affiliates.All Rights Reserved.</para> </copyright> </details> <description> <para>Updates the webhook associated with an AWS CodeBuild build project. If you use Bitbucket for your repository, <code>rotateSecret</code> is ignored. </para> </description> <syntax> <syntaxItem> <name>Update-CBWebhook</name> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BranchFilter</name> <description> <para>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built. It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>FilterGroup</name> <description> <para> An array of arrays of <code>WebhookFilter</code> objects used to determine if a webhook event can trigger a build. A filter group must pcontain at least one <code>EVENT</code><code>WebhookFilter</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.WebhookFilter[][]</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RotateSecret</name> <description> <para> A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, <code>rotateSecret</code> is ignored. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Webhook'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.UpdateWebhookResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.UpdateWebhookResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> </parameter> </syntaxItem> </syntax> <parameters> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>BranchFilter</name> <description> <para>A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If <code>branchFilter</code> is empty, then all branches are built. It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>FilterGroup</name> <description> <para> An array of arrays of <code>WebhookFilter</code> objects used to determine if a webhook event can trigger a build. A filter group must pcontain at least one <code>EVENT</code><code>WebhookFilter</code>. </para> </description> <parameterValue required="true" variableLength="false">Amazon.CodeBuild.Model.WebhookFilter[][]</parameterValue> <type> <name>Amazon.CodeBuild.Model.WebhookFilter[][]</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Force</name> <description> <para>This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>PassThru</name> <description> <para>Changes the cmdlet behavior to return the value passed to the ProjectName parameter. The -PassThru parameter is deprecated, use -Select '^ProjectName' instead. This parameter will be removed in a future version. </para> </description> <parameterValue required="true" variableLength="false">System.Management.Automation.SwitchParameter</parameterValue> <type> <name>System.Management.Automation.SwitchParameter</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="True" variableLength="false" globbing="false" pipelineInput="True (ByValue, ByPropertyName)" position="1"> <name>ProjectName</name> <description> <para>The name of the AWS CodeBuild project. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>RotateSecret</name> <description> <para> A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, <code>rotateSecret</code> is ignored. </para> </description> <parameterValue required="true" variableLength="false">System.Boolean</parameterValue> <type> <name>System.Boolean</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> <parameter required="False" variableLength="false" globbing="false" pipelineInput="True (ByPropertyName)" position="Named"> <name>Select</name> <description> <para>Use the -Select parameter to control the cmdlet output. The default value is 'Webhook'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.UpdateWebhookResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.UpdateWebhookResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </para> </description> <parameterValue required="true" variableLength="false">System.String</parameterValue> <type> <name>System.String</name> <uri /> </type> <defaultValue>None</defaultValue> </parameter> </parameters> <returnValues> <returnValue> <type> <name>Amazon.CodeBuild.Model.Webhook or Amazon.CodeBuild.Model.UpdateWebhookResponse</name> <uri /> <description /> </type> <description> <para>This cmdlet returns an Amazon.CodeBuild.Model.Webhook object. The service call response (type Amazon.CodeBuild.Model.UpdateWebhookResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.</para> </description> </returnValue> </returnValues> <relatedLinks> <navigationLink> <linkText>Online version:</linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/index.html?page=Update-CBWebhook.html&tocid=Update-CBWebhook</uri> </navigationLink> <navigationLink> <linkText>Common credential and region parameters: </linkText> <uri>http://docs.aws.amazon.com/powershell/latest/reference/items/pstoolsref-commonparams.html</uri> </navigationLink> </relatedLinks> </command> </helpItems> |