AWS.Tools.CodeBuild.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CodeBuild</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBBatchCmdlet"> <summary> Retrieves information about one or more batch builds. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchCmdlet.Id"> <summary> <para> <para>An array that contains the batch build identifiers to retrieve.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchCmdlet.Select"> <summary> 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.BatchGetBuildBatchesResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.BatchGetBuildBatchesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListCmdlet"> <summary> Retrieves the identifiers of your build batches in the current region.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListCmdlet.SortOrder"> <summary> <para> <para>Specifies the sort order of the returned items. Valid values include:</para><ul><li><para><code>ASCENDING</code>: List the batch build identifiers in ascending order by identifier.</para></li><li><para><code>DESCENDING</code>: List the batch build identifiers in descending order by identifier.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListCmdlet.Filter_Status"> <summary> <para> <para>The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous call to <code>ListBuildBatches</code>. This specifies the next item to return. To return the beginning of the list, exclude this parameter.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListCmdlet.Select"> <summary> 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.ListBuildBatchesResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListBuildBatchesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the SortOrder parameter. The -PassThru parameter is deprecated, use -Select '^SortOrder' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListForProjectCmdlet"> <summary> Retrieves the identifiers of the build batches for a specific 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListForProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListForProjectCmdlet.SortOrder"> <summary> <para> <para>Specifies the sort order of the returned items. Valid values include:</para><ul><li><para><code>ASCENDING</code>: List the batch build identifiers in ascending order by identifier.</para></li><li><para><code>DESCENDING</code>: List the batch build identifiers in descending order by identifier.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListForProjectCmdlet.Filter_Status"> <summary> <para> <para>The status of the batch builds to retrieve. Only batch builds that have this status will be retrieved.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListForProjectCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListForProjectCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous call to <code>ListBuildBatchesForProject</code>. This specifies the next item to return. To return the beginning of the list, exclude this parameter.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListForProjectCmdlet.Select"> <summary> 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.ListBuildBatchesForProjectResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListBuildBatchesForProjectResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListForProjectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBatchIdListForProjectCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBBuildBatchCmdlet"> <summary> Gets information about one or more builds. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildBatchCmdlet.Id"> <summary> <para> <para>The IDs of the builds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildBatchCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildBatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListCmdlet.SortOrder"> <summary> <para> <para>The order to list build IDs. Valid values include:</para><ul><li><para><code>ASCENDING</code>: List the build IDs in ascending order by build ID.</para></li><li><para><code>DESCENDING</code>: List the build IDs in descending order by build ID.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListCmdlet.NextToken"> <summary> <para> <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.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet"> <summary> Gets a list of build identifiers for the specified build project, with each build identifier 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the CodeBuild project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet.SortOrder"> <summary> <para> <para>The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.</para><para>Valid values include:</para><ul><li><para><code>ASCENDING</code>: List the build identifiers in ascending order, by build number.</para></li><li><para><code>DESCENDING</code>: List the build identifiers in descending order, by build number.</para></li></ul><para>If the project has more than 100 builds, setting the sort order will result in an error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet.NextToken"> <summary> <para> <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.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet"> <summary> Retrieves one or more code coverage reports.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.MaxLineCoveragePercentage"> <summary> <para> <para>The maximum line coverage percentage to report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.MinLineCoveragePercentage"> <summary> <para> <para>The minimum line coverage percentage to report.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.ReportArn"> <summary> <para> <para> The ARN of the report for which test cases are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.SortBy"> <summary> <para> <para>Specifies how the results are sorted. Possible values are:</para><dl><dt>FILE_PATH</dt><dd><para>The results are sorted by file path.</para></dd><dt>LINE_COVERAGE_PERCENTAGE</dt><dd><para>The results are sorted by the percentage of lines that are covered.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.SortOrder"> <summary> <para> <para>Specifies if the results are sorted in ascending or descending order.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.MaxResult"> <summary> <para> <para>The maximum number of results to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.NextToken"> <summary> <para> <para>The <code>nextToken</code> value returned from a previous call to <code>DescribeCodeCoverages</code>. This specifies the next item to return. To return the beginning of the list, exclude this parameter.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'CodeCoverages'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.DescribeCodeCoveragesResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.DescribeCodeCoveragesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportArn parameter. The -PassThru parameter is deprecated, use -Select '^ReportArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCodeCoverageCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBCuratedEnvironmentImageListCmdlet"> <summary> Gets information about Docker images that are managed by CodeBuild. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBCuratedEnvironmentImageListCmdlet.Select"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBProjectBatchCmdlet"> <summary> Gets information about one or more build projects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBProjectBatchCmdlet.Name"> <summary> <para> <para>The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBProjectBatchCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBProjectBatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBProjectListCmdlet"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBProjectListCmdlet.SortBy"> <summary> <para> <para>The criterion to be used to list build project names. Valid values include:</para><ul><li><para><code>CREATED_TIME</code>: List based on when each build project was created.</para></li><li><para><code>LAST_MODIFIED_TIME</code>: List based on when information about each build project was last changed.</para></li><li><para><code>NAME</code>: List based on each build project's name.</para></li></ul><para>Use <code>sortOrder</code> to specify in what order to list the build project names based on the preceding criteria.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBProjectListCmdlet.SortOrder"> <summary> <para> <para>The order in which to list build projects. Valid values include:</para><ul><li><para><code>ASCENDING</code>: List in ascending order.</para></li><li><para><code>DESCENDING</code>: List in descending order.</para></li></ul><para>Use <code>sortBy</code> to specify the criterion to be used to list build project names.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBProjectListCmdlet.NextToken"> <summary> <para> <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.</para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBProjectListCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBProjectListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBReportBatchCmdlet"> <summary> Returns an array of reports. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportBatchCmdlet.ReportArn"> <summary> <para> <para> An array of ARNs that identify the <code>Report</code> objects to return. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Reports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.BatchGetReportsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.BatchGetReportsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupBatchCmdlet"> <summary> Returns an array of report groups. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupBatchCmdlet.ReportGroupArn"> <summary> <para> <para> An array of report group ARNs that identify the report groups to return. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.BatchGetReportGroupsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.BatchGetReportGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupListCmdlet"> <summary> Gets a list ARNs for the report groups in the current Amazon Web Services account.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupListCmdlet.SortBy"> <summary> <para> <para> The criterion to be used to list build report groups. Valid values include: </para><ul><li><para><code>CREATED_TIME</code>: List based on when each report group was created.</para></li><li><para><code>LAST_MODIFIED_TIME</code>: List based on when each report group was last changed.</para></li><li><para><code>NAME</code>: List based on each report group's name.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupListCmdlet.SortOrder"> <summary> <para> <para> Used to specify the order to sort the list of returned report groups. Valid values are <code>ASCENDING</code> and <code>DESCENDING</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of paginated report groups returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>ReportGroup</code> objects. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupListCmdlet.NextToken"> <summary> <para> <para> During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> is returned. 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. </para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListReportGroupsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListReportGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupTrendCmdlet"> <summary> Analyzes and accumulates test report values for the specified test reports. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupTrendCmdlet.NumOfReport"> <summary> <para> <para>The number of reports to analyze. This operation always retrieves the most recent reports.</para><para>If this parameter is omitted, the most recent 100 reports are analyzed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupTrendCmdlet.ReportGroupArn"> <summary> <para> <para>The ARN of the report group that contains the reports to analyze.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupTrendCmdlet.TrendField"> <summary> <para> <para>The test report value to accumulate. This must be one of the following values:</para><dl><dt>Test reports:</dt><dd><dl><dt>DURATION</dt><dd><para>Accumulate the test run times for the specified reports.</para></dd><dt>PASS_RATE</dt><dd><para>Accumulate the percentage of tests that passed for the specified test reports.</para></dd><dt>TOTAL</dt><dd><para>Accumulate the total number of tests for the specified test reports.</para></dd></dl></dd></dl><dl><dt>Code coverage reports:</dt><dd><dl><dt>BRANCH_COVERAGE</dt><dd><para>Accumulate the branch coverage percentages for the specified test reports.</para></dd><dt>BRANCHES_COVERED</dt><dd><para>Accumulate the branches covered values for the specified test reports.</para></dd><dt>BRANCHES_MISSED</dt><dd><para>Accumulate the branches missed values for the specified test reports.</para></dd><dt>LINE_COVERAGE</dt><dd><para>Accumulate the line coverage percentages for the specified test reports.</para></dd><dt>LINES_COVERED</dt><dd><para>Accumulate the lines covered values for the specified test reports.</para></dd><dt>LINES_MISSED</dt><dd><para>Accumulate the lines not covered values for the specified test reports.</para></dd></dl></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupTrendCmdlet.Select"> <summary> 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.GetReportGroupTrendResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.GetReportGroupTrendResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportGroupTrendCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^ReportGroupArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBReportListCmdlet"> <summary> Returns a list of ARNs for the reports in the current Amazon Web Services account.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportListCmdlet.SortOrder"> <summary> <para> <para> Specifies the sort order for the list of returned reports. Valid values are: </para><ul><li><para><code>ASCENDING</code>: return reports in chronological order based on their creation date. </para></li><li><para><code>DESCENDING</code>: return reports in the reverse chronological order based on their creation date. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportListCmdlet.Filter_Status"> <summary> <para> <para> The status used to filter reports. You can filter using one status only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of paginated reports returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>Report</code> objects. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportListCmdlet.NextToken"> <summary> <para> <para> During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> is returned. 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. </para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Reports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListReportsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListReportsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBReportsForReportGroupListCmdlet"> <summary> Returns a list of ARNs for the reports that belong to a <code>ReportGroup</code>.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportsForReportGroupListCmdlet.ReportGroupArn"> <summary> <para> <para> The ARN of the report group for which you want to return report ARNs. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportsForReportGroupListCmdlet.SortOrder"> <summary> <para> <para> Use to specify whether the results are returned in ascending or descending order. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportsForReportGroupListCmdlet.Filter_Status"> <summary> <para> <para> The status used to filter reports. You can filter using one status only. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportsForReportGroupListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of paginated reports in this report group returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>Report</code> objects. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportsForReportGroupListCmdlet.NextToken"> <summary> <para> <para> During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> is returned. 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. </para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportsForReportGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Reports'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListReportsForReportGroupResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListReportsForReportGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportsForReportGroupListCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportGroupArn parameter. The -PassThru parameter is deprecated, use -Select '^ReportGroupArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBReportsForReportGroupListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBResourcePolicyCmdlet"> <summary> Gets a resource policy that is identified by its resource ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para> The ARN of the resource that is associated with the resource policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'Policy'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.GetResourcePolicyResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.GetResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBSharedProjectListCmdlet"> <summary> Gets a list of projects that are shared with other Amazon Web Services accounts or users.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedProjectListCmdlet.SortBy"> <summary> <para> <para> The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include: </para><ul><li><para><code>ARN</code>: List based on the ARN. </para></li><li><para><code>MODIFIED_TIME</code>: List based on when information about the shared project was last changed. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedProjectListCmdlet.SortOrder"> <summary> <para> <para>The order in which to list shared build projects. Valid values include:</para><ul><li><para><code>ASCENDING</code>: List in ascending order.</para></li><li><para><code>DESCENDING</code>: List in descending order.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedProjectListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of paginated shared build projects returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>Project</code> objects. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedProjectListCmdlet.NextToken"> <summary> <para> <para> During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> is returned. 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. </para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedProjectListCmdlet.Select"> <summary> 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.ListSharedProjectsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListSharedProjectsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedProjectListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBSharedReportGroupListCmdlet"> <summary> Gets a list of report groups that are shared with other Amazon Web Services accounts or users.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedReportGroupListCmdlet.SortBy"> <summary> <para> <para> The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include: </para><ul><li><para><code>ARN</code>: List based on the ARN. </para></li><li><para><code>MODIFIED_TIME</code>: List based on when information about the shared report group was last changed. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedReportGroupListCmdlet.SortOrder"> <summary> <para> <para>The order in which to list shared report groups. Valid values include:</para><ul><li><para><code>ASCENDING</code>: List in ascending order.</para></li><li><para><code>DESCENDING</code>: List in descending order.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedReportGroupListCmdlet.MaxResult"> <summary> <para> <para> The maximum number of paginated shared report groups per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>ReportGroup</code> objects. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedReportGroupListCmdlet.NextToken"> <summary> <para> <para> During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> is returned. 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. </para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedReportGroupListCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportGroups'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.ListSharedReportGroupsResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.ListSharedReportGroupsResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSharedReportGroupListCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBSourceCredentialListCmdlet"> <summary> Returns a list of <code>SourceCredentialsInfo</code> objects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBSourceCredentialListCmdlet.Select"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBTestCaseCmdlet"> <summary> Returns a list of details about test cases for a report.<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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBTestCaseCmdlet.Filter_Keyword"> <summary> <para> <para>A keyword that is used to filter on the <code>name</code> or the <code>prefix</code> of the test cases. Only test cases where the keyword is a substring of the <code>name</code> or the <code>prefix</code> will be returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBTestCaseCmdlet.ReportArn"> <summary> <para> <para> The ARN of the report for which test cases are returned. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBTestCaseCmdlet.Filter_Status"> <summary> <para> <para>The status used to filter test cases. A <code>TestCaseFilter</code> can have one status. Valid values are:</para><ul><li><para><code>SUCCEEDED</code></para></li><li><para><code>FAILED</code></para></li><li><para><code>ERROR</code></para></li><li><para><code>SKIPPED</code></para></li><li><para><code>UNKNOWN</code></para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBTestCaseCmdlet.MaxResult"> <summary> <para> <para> The maximum number of paginated test cases returned per response. Use <code>nextToken</code> to iterate pages in the list of returned <code>TestCase</code> objects. The default value is 100. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBTestCaseCmdlet.NextToken"> <summary> <para> <para> During a previous call, the maximum number of items that can be returned is the value specified in <code>maxResults</code>. If there more items in the list, then a unique string called a <i>nextToken</i> is returned. 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. </para> </para> <para> <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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBTestCaseCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'TestCases'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.DescribeTestCasesResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.DescribeTestCasesResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBTestCaseCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ReportArn parameter. The -PassThru parameter is deprecated, use -Select '^ReportArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBTestCaseCmdlet.NoAutoIteration"> <summary> 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. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet"> <summary> Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet.AuthType"> <summary> <para> <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 CodeBuild console. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet.ServerType"> <summary> <para> <para> The source provider used for this project. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet.ShouldOverwrite"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet.Token"> <summary> <para> <para> For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet.Username"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet"> <summary> Creates a build project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_ArtifactIdentifier"> <summary> <para> <para> An identifier for this artifact definition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.BadgeEnabled"> <summary> <para> <para>Set this to true to generate a publicly accessible URL for your project's build badge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.BuildBatchConfig_BatchReportMode"> <summary> <para> <para>Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.</para><dl><dt>REPORT_AGGREGATED_BATCH</dt><dd><para>(Default) Aggregate all of the build statuses into a single status report.</para></dd><dt>REPORT_INDIVIDUAL_BUILDS</dt><dd><para>Send a separate status report for each individual build.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_BucketOwnerAccess"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.S3Logs_BucketOwnerAccess"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Source_Buildspec"> <summary> <para> <para>The buildspec file declaration to use for the builds in this build project.</para><para> If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Environment_Certificate"> <summary> <para> <para>The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate">certificate</a> in the <i>CodeBuild User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.BuildBatchConfig_CombineArtifact"> <summary> <para> <para>Specifies if the build artifacts for the batch build should be combined into a single artifact location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Environment_ComputeType"> <summary> <para> <para>Information about the compute resources the build project uses. Available values include:</para><ul><li><para><code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds.</para></li><li><para><code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds.</para></li><li><para><code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.</para></li><li><para><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.</para></li><li><para><code>BUILD_LAMBDA_1GB</code>: Use up to 1 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li><li><para><code>BUILD_LAMBDA_2GB</code>: Use up to 2 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li><li><para><code>BUILD_LAMBDA_4GB</code>: Use up to 4 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li><li><para><code>BUILD_LAMBDA_8GB</code>: Use up to 8 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li><li><para><code>BUILD_LAMBDA_10GB</code>: Use up to 10 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li></ul><para> If you use <code>BUILD_GENERAL1_SMALL</code>: </para><ul><li><para> For environment type <code>LINUX_CONTAINER</code>, you can use up to 3 GB memory and 2 vCPUs for builds. </para></li><li><para> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.</para></li><li><para> For environment type <code>ARM_CONTAINER</code>, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.</para></li></ul><para> If you use <code>BUILD_GENERAL1_LARGE</code>: </para><ul><li><para> For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. </para></li><li><para> 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.</para></li><li><para> For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.</para></li></ul><para>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>CodeBuild User Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Restrictions_ComputeTypesAllowed"> <summary> <para> <para>An array of strings that specify the compute types that are allowed for the batch build. 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>CodeBuild User Guide</i> for these values. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.ConcurrentBuildLimit"> <summary> <para> <para>The maximum number of concurrent builds that are allowed for this project.</para><para>New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.BuildStatusConfig_Context"> <summary> <para> <para>Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</para><dl><dt>Bitbucket</dt><dd><para>This parameter is used for the <code>name</code> parameter in the Bitbucket commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</para></dd><dt>GitHub/GitHub Enterprise Server</dt><dd><para>This parameter is used for the <code>context</code> parameter in the GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.RegistryCredential_Credential"> <summary> <para> <para> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </para><note><para> The <code>credential</code> can use the name of the credentials only if they exist in your current Amazon Web Services Region. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.RegistryCredential_CredentialProvider"> <summary> <para> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Description"> <summary> <para> <para>A description that makes the build project easy to identify.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_EncryptionDisabled"> <summary> <para> <para> Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.S3Logs_EncryptionDisabled"> <summary> <para> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.EncryptionKey"> <summary> <para> <para>The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.</para><note><para>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </para></note><para>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Environment_EnvironmentVariable"> <summary> <para> <para>A set of environment variables to make available to builds for this build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.GitSubmodulesConfig_FetchSubmodule"> <summary> <para> <para> Set to true to fetch Git submodules for your CodeBuild build project. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.FileSystemLocation"> <summary> <para> <para> An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Source_GitCloneDepth"> <summary> <para> <para>Information about the Git clone depth for the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.CloudWatchLogs_GroupName"> <summary> <para> <para> The group name of the logs in 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Environment_Image"> <summary> <para> <para>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</para><ul><li><para>For an image tag: <code><registry>/<repository>:<tag></code>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be <code>aws/codebuild/standard:4.0</code>. </para></li><li><para>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></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html">Docker images provided by CodeBuild</a> in the <i>CodeBuild user guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Environment_ImagePullCredentialsType"> <summary> <para> <para> The type of credentials CodeBuild uses to pull images in your build. There are two valid values: </para><ul><li><para><code>CODEBUILD</code> specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. </para></li><li><para><code>SERVICE_ROLE</code> specifies that CodeBuild uses your build project's service role. </para></li></ul><para> When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Source_InsecureSsl"> <summary> <para> <para>Enable this flag to ignore SSL warnings while connecting to the project source code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_Location"> <summary> <para> <para>Information about the build output artifact location:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Cache_Location"> <summary> <para> <para>Information about the cache location: </para><ul><li><para><code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored.</para></li><li><para><code>S3</code>: This is the S3 bucket name/prefix.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.S3Logs_Location"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Source_Location"> <summary> <para> <para>Information about the location of the source code to be built. Valid values include:</para><ul><li><para>For source code settings that are specified in the source action of a pipeline in CodePipeline, <code>location</code> should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.</para></li><li><para>For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, <code>https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name></code>).</para></li><li><para>For source code in an Amazon S3 input bucket, one of the following. </para><ul><li><para>The path to the ZIP file that contains the source code (for example, <code><bucket-name>/<path>/<object-name>.zip</code>). </para></li><li><para>The path to the folder that contains the source code (for example, <code><bucket-name>/<path-to-source-code>/<folder>/</code>). </para></li></ul></li><li><para>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the 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 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 CodeBuild console.) To instruct 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></li><li><para>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the 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 CodeBuild console.) To instruct 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></li></ul><para> If you specify <code>CODEPIPELINE</code> for the <code>Type</code> property, don't specify this property. For all of the other types, you must specify <code>Location</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Restrictions_MaximumBuildsAllowed"> <summary> <para> <para>Specifies the maximum number of builds allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Cache_Mode"> <summary> <para> <para>An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for <code>LOCAL</code> cache types.</para><para>Possible values are:</para><dl><dt>LOCAL_SOURCE_CACHE</dt><dd><para>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. </para></dd><dt>LOCAL_DOCKER_LAYER_CACHE</dt><dd><para>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. </para><note><ul><li><para>You can use a Docker layer cache in the Linux environment only. </para></li><li><para>The <code>privileged</code> flag must be set so that your project has the required Docker permissions. </para></li><li><para>You should consider the security implications before you use a Docker layer cache. </para></li></ul></note></dd><dt>LOCAL_CUSTOM_CACHE</dt><dd><para>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: </para><ul><li><para>Only directories can be specified for caching. You cannot specify individual files. </para></li><li><para>Symlinks are used to reference cached directories. </para></li><li><para>Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para></li></ul></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_Name"> <summary> <para> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>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.</para></li></ul><para>For example:</para><ul><li><para> 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/<build-ID>/MyArtifact.zip</code>. </para></li><li><para> 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. </para></li><li><para> 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/<build-ID></code>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Name"> <summary> <para> <para>The name of the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_NamespaceType"> <summary> <para> <para>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to determine the name and location to store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, valid values include:</para><ul><li><para><code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</para></li><li><para><code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</para></li></ul></li></ul><para>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/<build-ID>/MyArtifact.zip</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_OverrideArtifactName"> <summary> <para> <para> If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_Packaging"> <summary> <para> <para>The type of build output artifact to create:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, valid values include:</para><ul><li><para><code>NONE</code>: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</para></li><li><para><code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that contains the build output.</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_Path"> <summary> <para> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>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.</para></li></ul><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Environment_PrivilegedMode"> <summary> <para> <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>.</para><para>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:</para><para>If the operating system's base image is Ubuntu Linux:</para><para><code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code></para><para><code>- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"</code></para><para>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>:</para><para><code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code></para><para><code>- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.QueuedTimeoutInMinute"> <summary> <para> <para>The number of minutes a build is allowed to be queued before it times out. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Source_ReportBuildStatus"> <summary> <para> <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 <code>invalidInputException</code> is thrown. </para><para>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</para><para>The status of a build triggered by a webhook is always reported to your source provider. </para><para>If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Auth_Resource"> <summary> <para> <para>The resource value that applies to the specified authorization type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.SecondaryArtifact"> <summary> <para> <para>An array of <code>ProjectArtifacts</code> objects. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.SecondarySource"> <summary> <para> <para>An array of <code>ProjectSource</code> objects. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.SecondarySourceVersion"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>A list of one or more security groups IDs in your Amazon VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.BuildBatchConfig_ServiceRole"> <summary> <para> <para>Specifies the service role ARN for the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.ServiceRole"> <summary> <para> <para>The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Source_SourceIdentifier"> <summary> <para> <para>An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.SourceVersion"> <summary> <para> <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: </para><ul><li><para>For CodeCommit: the commit ID, branch, or Git tag to use.</para></li><li><para>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.</para></li><li><para>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.</para></li><li><para>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</para></li></ul><para>If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). </para><para>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>CodeBuild User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.CloudWatchLogs_Status"> <summary> <para> <para>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</para><ul><li><para><code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.S3Logs_Status"> <summary> <para> <para>The current status of the S3 build logs. Valid values are:</para><ul><li><para><code>ENABLED</code>: S3 build logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: S3 build logs are not enabled for this build project.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.CloudWatchLogs_StreamName"> <summary> <para> <para> The prefix of the stream name of the 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.VpcConfig_Subnet"> <summary> <para> <para>A list of one or more subnet IDs in your Amazon VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Tag"> <summary> <para> <para>A list of tag key and value pairs associated with this build project.</para><para>These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.BuildStatusConfig_TargetUrl"> <summary> <para> <para>Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</para><dl><dt>Bitbucket</dt><dd><para>This parameter is used for the <code>url</code> parameter in the Bitbucket commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</para></dd><dt>GitHub/GitHub Enterprise Server</dt><dd><para>This parameter is used for the <code>target_url</code> parameter in the GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.BuildBatchConfig_TimeoutInMin"> <summary> <para> <para>Specifies the maximum amount of time, in minutes, that the batch build must be completed in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.TimeoutInMinute"> <summary> <para> <para>How long, in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Artifacts_Type"> <summary> <para> <para>The type of build output artifact. Valid values include:</para><ul><li><para><code>CODEPIPELINE</code>: The build project has build output generated through CodePipeline. </para><note><para>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</para></note></li><li><para><code>NO_ARTIFACTS</code>: The build project does not produce any build output.</para></li><li><para><code>S3</code>: The build project stores build output in Amazon S3.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Cache_Type"> <summary> <para> <para>The type of cache used by the build project. Valid values include:</para><ul><li><para><code>NO_CACHE</code>: The build project does not use any cache.</para></li><li><para><code>S3</code>: The build project reads and writes from and to S3.</para></li><li><para><code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Environment_Type"> <summary> <para> <para>The type of build environment to use for related builds.</para><ul><li><para>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).</para></li><li><para>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 (Ohio), 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></li><li><para>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), 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></li></ul><ul><li><para>The environment types <code>ARM_LAMBDA_CONTAINER</code> and <code>LINUX_LAMBDA_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).</para></li></ul><ul><li><para>The environment types <code>WINDOWS_CONTAINER</code> and <code>WINDOWS_SERVER_2019_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).</para></li></ul><para>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>CodeBuild user guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Auth_Type"> <summary> <para> <note><para> This data type is deprecated and is no longer accurate or used. </para></note><para>The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Source_Type"> <summary> <para> <para>The type of repository that contains the source code to be built. Valid values include:</para><ul><li><para><code>BITBUCKET</code>: The source code is in a Bitbucket repository.</para></li><li><para><code>CODECOMMIT</code>: The source code is in an CodeCommit repository.</para></li><li><para><code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in CodePipeline.</para></li><li><para><code>GITHUB</code>: The source code is in a GitHub or GitHub Enterprise Cloud repository.</para></li><li><para><code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise Server repository.</para></li><li><para><code>NO_SOURCE</code>: The project does not have input source code.</para></li><li><para><code>S3</code>: The source code is in an Amazon S3 bucket.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.VpcConfig_VpcId"> <summary> <para> <para>The ID of the Amazon VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet"> <summary> Creates a report group. A report group contains a collection of reports. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.S3Destination_Bucket"> <summary> <para> <para> The name of the S3 bucket where the raw data of a report are exported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.S3Destination_BucketOwner"> <summary> <para> <para>The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.S3Destination_EncryptionDisabled"> <summary> <para> <para> A boolean value that specifies if the results of a report are encrypted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.S3Destination_EncryptionKey"> <summary> <para> <para> The encryption key for the report's encrypted raw data. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.ExportConfig_ExportConfigType"> <summary> <para> <para> The export configuration type. Valid values are: </para><ul><li><para><code>S3</code>: The report results are exported to an S3 bucket. </para></li><li><para><code>NO_EXPORT</code>: The report results are not exported. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.Name"> <summary> <para> <para> The name of the report group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.S3Destination_Packaging"> <summary> <para> <para> The type of build output artifact to create. Valid values include: </para><ul><li><para><code>NONE</code>: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified. </para></li><li><para><code>ZIP</code>: CodeBuild creates a ZIP file with the raw data in the output bucket. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.S3Destination_Path"> <summary> <para> <para> The path to the exported report's raw data results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.Tag"> <summary> <para> <para> A list of tag key and value pairs associated with this report group. </para><para>These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.Type"> <summary> <para> <para> The type of report group. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.CreateReportGroupResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.CreateReportGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBReportGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.NewCBWebhookCmdlet"> <summary> For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables 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 CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the 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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBWebhookCmdlet.BranchFilter"> <summary> <para> <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.</para><note><para>It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBWebhookCmdlet.BuildType"> <summary> <para> <para>Specifies the type of build this webhook will trigger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBWebhookCmdlet.FilterGroup"> <summary> <para> <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>. </para><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBWebhookCmdlet.ProjectName"> <summary> <para> <para>The name of the CodeBuild project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBWebhookCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBWebhookCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBWebhookCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RedoCBBatchCmdlet"> <summary> Restarts a failed batch build. Only batch builds that have failed can be retried. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBatchCmdlet.Id"> <summary> <para> <para>Specifies the identifier of the batch build to restart.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBatchCmdlet.IdempotencyToken"> <summary> <para> <para>A unique, case sensitive identifier you provide to ensure the idempotency of the <code>RetryBuildBatch</code> request. The token is included in the <code>RetryBuildBatch</code> request and is valid for five minutes. If you repeat the <code>RetryBuildBatch</code> request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBatchCmdlet.RetryType"> <summary> <para> <para>Specifies the type of retry to perform.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BuildBatch'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.RetryBuildBatchResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.RetryBuildBatchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RedoCBBuildCmdlet"> <summary> Restarts a build. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBuildCmdlet.Id"> <summary> <para> <para>Specifies the identifier of the build to restart.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBuildCmdlet.IdempotencyToken"> <summary> <para> <para>A unique, case sensitive identifier you provide to ensure the idempotency of the <code>RetryBuild</code> request. The token is included in the <code>RetryBuild</code> request and is valid for five minutes. If you repeat the <code>RetryBuild</code> request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBuildCmdlet.Select"> <summary> 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.RetryBuildResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.RetryBuildResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBuildCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RedoCBBuildCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RemoveCBBatchCmdlet"> <summary> Deletes a batch build. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBBatchCmdlet.Id"> <summary> <para> <para>The identifier of the batch build to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBBatchCmdlet.Select"> <summary> 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.DeleteBuildBatchResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.DeleteBuildBatchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBBatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RemoveCBBuildBatchCmdlet"> <summary> Deletes one or more builds. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBBuildBatchCmdlet.Id"> <summary> <para> <para>The IDs of the builds to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBBuildBatchCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBBuildBatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBBuildBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RemoveCBProjectCmdlet"> <summary> Deletes a build project. When you delete a project, its builds are not deleted. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBProjectCmdlet.Name"> <summary> <para> <para>The name of the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBProjectCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBProjectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportCmdlet"> <summary> Deletes a report. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportCmdlet.Arn"> <summary> <para> <para> The ARN of the report to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportCmdlet.Select"> <summary> 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.DeleteReportResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportGroupCmdlet"> <summary> Deletes a report group. Before you delete a report group, you must delete its reports. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportGroupCmdlet.Arn"> <summary> <para> <para>The ARN of the report group to delete. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportGroupCmdlet.DeleteReport"> <summary> <para> <para>If <code>true</code>, deletes any reports that belong to a report group before deleting the report group. </para><para>If <code>false</code>, you must delete any reports in the report group. Use <a href="https://docs.aws.amazon.com/codebuild/latest/APIReference/API_ListReportsForReportGroup.html">ListReportsForReportGroup</a> to get the reports in a report group. Use <a href="https://docs.aws.amazon.com/codebuild/latest/APIReference/API_DeleteReport.html">DeleteReport</a> to delete the reports. If you call <code>DeleteReportGroup</code> for a report group that contains one or more reports, an exception is thrown. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportGroupCmdlet.Select"> <summary> 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.DeleteReportGroupResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBReportGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RemoveCBResourcePolicyCmdlet"> <summary> Deletes a resource policy that is identified by its resource ARN. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para> The ARN of the resource that is associated with the resource policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBResourcePolicyCmdlet.Select"> <summary> 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.DeleteResourcePolicyResponse). Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBResourcePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RemoveCBSourceCredentialCmdlet"> <summary> Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBSourceCredentialCmdlet.Arn"> <summary> <para> <para> The Amazon Resource Name (ARN) of the token.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBSourceCredentialCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBSourceCredentialCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBSourceCredentialCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.RemoveCBWebhookCmdlet"> <summary> For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBWebhookCmdlet.ProjectName"> <summary> <para> <para>The name of the CodeBuild project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBWebhookCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBWebhookCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBWebhookCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.ResetCBProjectCacheCmdlet"> <summary> Resets the cache for a project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ResetCBProjectCacheCmdlet.ProjectName"> <summary> <para> <para>The name of the CodeBuild build project that the cache is reset for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ResetCBProjectCacheCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ResetCBProjectCacheCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ResetCBProjectCacheCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet"> <summary> Starts a batch build for a project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_ArtifactIdentifier"> <summary> <para> <para> An identifier for this artifact definition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.BuildBatchConfigOverride_BatchReportMode"> <summary> <para> <para>Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.</para><dl><dt>REPORT_AGGREGATED_BATCH</dt><dd><para>(Default) Aggregate all of the build statuses into a single status report.</para></dd><dt>REPORT_INDIVIDUAL_BUILDS</dt><dd><para>Send a separate status report for each individual build.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_BucketOwnerAccess"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.S3Logs_BucketOwnerAccess"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.BuildspecOverride"> <summary> <para> <para>A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.</para><para>If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.BuildTimeoutInMinutesOverride"> <summary> <para> <para>Overrides the build timeout specified in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.CertificateOverride"> <summary> <para> <para>The name of a certificate for this batch build that overrides the one specified in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.BuildBatchConfigOverride_CombineArtifact"> <summary> <para> <para>Specifies if the build artifacts for the batch build should be combined into a single artifact location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ComputeTypeOverride"> <summary> <para> <para>The name of a compute type for this batch build that overrides the one specified in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.Restrictions_ComputeTypesAllowed"> <summary> <para> <para>An array of strings that specify the compute types that are allowed for the batch build. 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>CodeBuild User Guide</i> for these values. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.RegistryCredentialOverride_Credential"> <summary> <para> <para> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </para><note><para> The <code>credential</code> can use the name of the credentials only if they exist in your current Amazon Web Services Region. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.RegistryCredentialOverride_CredentialProvider"> <summary> <para> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.DebugSessionEnabled"> <summary> <para> <para>Specifies if session debugging is enabled for this batch build. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>. Batch session debugging is not supported for matrix batch builds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_EncryptionDisabled"> <summary> <para> <para> Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.S3Logs_EncryptionDisabled"> <summary> <para> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.EncryptionKeyOverride"> <summary> <para> <para>The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.</para><note><para>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </para></note><para>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.EnvironmentTypeOverride"> <summary> <para> <para>A container type for this batch build that overrides the one specified in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.EnvironmentVariablesOverride"> <summary> <para> <para>An array of <code>EnvironmentVariable</code> objects that override, or add to, the environment variables defined in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.GitSubmodulesConfigOverride_FetchSubmodule"> <summary> <para> <para> Set to true to fetch Git submodules for your CodeBuild build project. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.GitCloneDepthOverride"> <summary> <para> <para>The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.CloudWatchLogs_GroupName"> <summary> <para> <para> The group name of the logs in 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.IdempotencyToken"> <summary> <para> <para>A unique, case sensitive identifier you provide to ensure the idempotency of the <code>StartBuildBatch</code> request. The token is included in the <code>StartBuildBatch</code> request and is valid for five minutes. If you repeat the <code>StartBuildBatch</code> request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ImageOverride"> <summary> <para> <para>The name of an image for this batch build that overrides the one specified in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ImagePullCredentialsTypeOverride"> <summary> <para> <para>The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values: </para><dl><dt>CODEBUILD</dt><dd><para>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.</para></dd><dt>SERVICE_ROLE</dt><dd><para>Specifies that CodeBuild uses your build project's service role. </para></dd></dl><para>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image, you must use <code>CODEBUILD</code> credentials. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.InsecureSslOverride"> <summary> <para> <para>Enable this flag to override the insecure SSL setting that is specified in the batch 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_Location"> <summary> <para> <para>Information about the build output artifact location:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.CacheOverride_Location"> <summary> <para> <para>Information about the cache location: </para><ul><li><para><code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored.</para></li><li><para><code>S3</code>: This is the S3 bucket name/prefix.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.S3Logs_Location"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.Restrictions_MaximumBuildsAllowed"> <summary> <para> <para>Specifies the maximum number of builds allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.CacheOverride_Mode"> <summary> <para> <para>An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for <code>LOCAL</code> cache types.</para><para>Possible values are:</para><dl><dt>LOCAL_SOURCE_CACHE</dt><dd><para>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. </para></dd><dt>LOCAL_DOCKER_LAYER_CACHE</dt><dd><para>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. </para><note><ul><li><para>You can use a Docker layer cache in the Linux environment only. </para></li><li><para>The <code>privileged</code> flag must be set so that your project has the required Docker permissions. </para></li><li><para>You should consider the security implications before you use a Docker layer cache. </para></li></ul></note></dd><dt>LOCAL_CUSTOM_CACHE</dt><dd><para>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: </para><ul><li><para>Only directories can be specified for caching. You cannot specify individual files. </para></li><li><para>Symlinks are used to reference cached directories. </para></li><li><para>Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para></li></ul></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_Name"> <summary> <para> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>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.</para></li></ul><para>For example:</para><ul><li><para> 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/<build-ID>/MyArtifact.zip</code>. </para></li><li><para> 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. </para></li><li><para> 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/<build-ID></code>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_NamespaceType"> <summary> <para> <para>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to determine the name and location to store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, valid values include:</para><ul><li><para><code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</para></li><li><para><code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</para></li></ul></li></ul><para>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/<build-ID>/MyArtifact.zip</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_OverrideArtifactName"> <summary> <para> <para> If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_Packaging"> <summary> <para> <para>The type of build output artifact to create:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, valid values include:</para><ul><li><para><code>NONE</code>: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</para></li><li><para><code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that contains the build output.</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_Path"> <summary> <para> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>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.</para></li></ul><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.PrivilegedModeOverride"> <summary> <para> <para>Enable this flag to override privileged mode in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ProjectName"> <summary> <para> <para>The name of the project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.QueuedTimeoutInMinutesOverride"> <summary> <para> <para>The number of minutes a batch build is allowed to be queued before it times out.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ReportBuildBatchStatusOverride"> <summary> <para> <para>Set to <code>true</code> to report to your source provider the status of a batch build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an <code>invalidInputException</code> is thrown. </para><note><para>The status of a build triggered by a webhook is always reported to your source provider. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.SourceAuthOverride_Resource"> <summary> <para> <para>The resource value that applies to the specified authorization type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.SecondaryArtifactsOverride"> <summary> <para> <para>An array of <code>ProjectArtifacts</code> objects that override the secondary artifacts defined in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.SecondarySourcesOverride"> <summary> <para> <para>An array of <code>ProjectSource</code> objects that override the secondary sources defined in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.SecondarySourcesVersionOverride"> <summary> <para> <para>An array of <code>ProjectSourceVersion</code> objects that override the secondary source versions in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.BuildBatchConfigOverride_ServiceRole"> <summary> <para> <para>Specifies the service role ARN for the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ServiceRoleOverride"> <summary> <para> <para>The name of a service role for this batch build that overrides the one specified in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.SourceLocationOverride"> <summary> <para> <para>A location that overrides, for this batch build, the source location defined in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.SourceTypeOverride"> <summary> <para> <para>The source input type that overrides the source input defined in the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.SourceVersion"> <summary> <para> <para>The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:</para><dl><dt>CodeCommit</dt><dd><para>The commit ID, branch, or Git tag to use.</para></dd><dt>GitHub</dt><dd><para>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.</para></dd><dt>Bitbucket</dt><dd><para>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.</para></dd><dt>Amazon S3</dt><dd><para>The version ID of the object that represents the build input ZIP file to use.</para></dd></dl><para>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. </para><para>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>CodeBuild User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.CloudWatchLogs_Status"> <summary> <para> <para>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</para><ul><li><para><code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.S3Logs_Status"> <summary> <para> <para>The current status of the S3 build logs. Valid values are:</para><ul><li><para><code>ENABLED</code>: S3 build logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: S3 build logs are not enabled for this build project.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.CloudWatchLogs_StreamName"> <summary> <para> <para> The prefix of the stream name of the 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.BuildBatchConfigOverride_TimeoutInMin"> <summary> <para> <para>Specifies the maximum amount of time, in minutes, that the batch build must be completed in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.ArtifactsOverride_Type"> <summary> <para> <para>The type of build output artifact. Valid values include:</para><ul><li><para><code>CODEPIPELINE</code>: The build project has build output generated through CodePipeline. </para><note><para>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</para></note></li><li><para><code>NO_ARTIFACTS</code>: The build project does not produce any build output.</para></li><li><para><code>S3</code>: The build project stores build output in Amazon S3.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.CacheOverride_Type"> <summary> <para> <para>The type of cache used by the build project. Valid values include:</para><ul><li><para><code>NO_CACHE</code>: The build project does not use any cache.</para></li><li><para><code>S3</code>: The build project reads and writes from and to S3.</para></li><li><para><code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.SourceAuthOverride_Type"> <summary> <para> <note><para> This data type is deprecated and is no longer accurate or used. </para></note><para>The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BuildBatch'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.StartBuildBatchResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.StartBuildBatchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet"> <summary> Starts running a build. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_ArtifactIdentifier"> <summary> <para> <para> An identifier for this artifact definition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_BucketOwnerAccess"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.S3Logs_BucketOwnerAccess"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.BuildspecOverride"> <summary> <para> <para>A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.</para><para> If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.CertificateOverride"> <summary> <para> <para>The name of a certificate for this build that overrides the one specified in the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ComputeTypeOverride"> <summary> <para> <para>The name of a compute type for this build that overrides the one specified in the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.BuildStatusConfigOverride_Context"> <summary> <para> <para>Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</para><dl><dt>Bitbucket</dt><dd><para>This parameter is used for the <code>name</code> parameter in the Bitbucket commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</para></dd><dt>GitHub/GitHub Enterprise Server</dt><dd><para>This parameter is used for the <code>context</code> parameter in the GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.RegistryCredentialOverride_Credential"> <summary> <para> <para> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </para><note><para> The <code>credential</code> can use the name of the credentials only if they exist in your current Amazon Web Services Region. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.RegistryCredentialOverride_CredentialProvider"> <summary> <para> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.DebugSessionEnabled"> <summary> <para> <para>Specifies if session debugging is enabled for this build. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_EncryptionDisabled"> <summary> <para> <para> Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.S3Logs_EncryptionDisabled"> <summary> <para> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.EncryptionKeyOverride"> <summary> <para> <para>The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.</para><note><para> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </para></note><para>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.EnvironmentTypeOverride"> <summary> <para> <para>A container type for this build that overrides the one specified in the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.EnvironmentVariablesOverride"> <summary> <para> <para>A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.GitSubmodulesConfigOverride_FetchSubmodule"> <summary> <para> <para> Set to true to fetch Git submodules for your CodeBuild build project. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.GitCloneDepthOverride"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.CloudWatchLogs_GroupName"> <summary> <para> <para> The group name of the logs in 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.IdempotencyToken"> <summary> <para> <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 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ImageOverride"> <summary> <para> <para>The name of an image for this build that overrides the one specified in the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ImagePullCredentialsTypeOverride"> <summary> <para> <para>The type of credentials CodeBuild uses to pull images in your build. There are two valid values: </para><dl><dt>CODEBUILD</dt><dd><para>Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.</para></dd><dt>SERVICE_ROLE</dt><dd><para>Specifies that CodeBuild uses your build project's service role. </para></dd></dl><para>When using a cross-account or private registry image, you must use <code>SERVICE_ROLE</code> credentials. When using an CodeBuild curated image, you must use <code>CODEBUILD</code> credentials. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.InsecureSslOverride"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_Location"> <summary> <para> <para>Information about the build output artifact location:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.CacheOverride_Location"> <summary> <para> <para>Information about the cache location: </para><ul><li><para><code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored.</para></li><li><para><code>S3</code>: This is the S3 bucket name/prefix.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.S3Logs_Location"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.CacheOverride_Mode"> <summary> <para> <para>An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for <code>LOCAL</code> cache types.</para><para>Possible values are:</para><dl><dt>LOCAL_SOURCE_CACHE</dt><dd><para>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. </para></dd><dt>LOCAL_DOCKER_LAYER_CACHE</dt><dd><para>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. </para><note><ul><li><para>You can use a Docker layer cache in the Linux environment only. </para></li><li><para>The <code>privileged</code> flag must be set so that your project has the required Docker permissions. </para></li><li><para>You should consider the security implications before you use a Docker layer cache. </para></li></ul></note></dd><dt>LOCAL_CUSTOM_CACHE</dt><dd><para>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: </para><ul><li><para>Only directories can be specified for caching. You cannot specify individual files. </para></li><li><para>Symlinks are used to reference cached directories. </para></li><li><para>Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para></li></ul></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_Name"> <summary> <para> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>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.</para></li></ul><para>For example:</para><ul><li><para> 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/<build-ID>/MyArtifact.zip</code>. </para></li><li><para> 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. </para></li><li><para> 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/<build-ID></code>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_NamespaceType"> <summary> <para> <para>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to determine the name and location to store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, valid values include:</para><ul><li><para><code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</para></li><li><para><code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</para></li></ul></li></ul><para>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/<build-ID>/MyArtifact.zip</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_OverrideArtifactName"> <summary> <para> <para> If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_Packaging"> <summary> <para> <para>The type of build output artifact to create:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, valid values include:</para><ul><li><para><code>NONE</code>: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</para></li><li><para><code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that contains the build output.</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_Path"> <summary> <para> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>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.</para></li></ul><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.PrivilegedModeOverride"> <summary> <para> <para>Enable this flag to override privileged mode in the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ProjectName"> <summary> <para> <para>The name of the CodeBuild build project to start running a build.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.QueuedTimeoutInMinutesOverride"> <summary> <para> <para> The number of minutes a build is allowed to be queued before it times out. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ReportBuildStatusOverride"> <summary> <para> <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 <code>invalidInputException</code> is thrown. </para><para>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</para><note><para> The status of a build triggered by a webhook is always reported to your source provider. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.SourceAuthOverride_Resource"> <summary> <para> <para>The resource value that applies to the specified authorization type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.SecondaryArtifactsOverride"> <summary> <para> <para> An array of <code>ProjectArtifacts</code> objects. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.SecondarySourcesOverride"> <summary> <para> <para> An array of <code>ProjectSource</code> objects. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.SecondarySourcesVersionOverride"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ServiceRoleOverride"> <summary> <para> <para>The name of a service role for this build that overrides the one specified in the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.SourceLocationOverride"> <summary> <para> <para>A location that overrides, for this build, the source location for the one defined in the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.SourceTypeOverride"> <summary> <para> <para>A source input type, for this build, that overrides the source input defined in the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.SourceVersion"> <summary> <para> <para>The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:</para><dl><dt>CodeCommit</dt><dd><para>The commit ID, branch, or Git tag to use.</para></dd><dt>GitHub</dt><dd><para>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.</para></dd><dt>Bitbucket</dt><dd><para>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.</para></dd><dt>Amazon S3</dt><dd><para>The version ID of the object that represents the build input ZIP file to use.</para></dd></dl><para>If <code>sourceVersion</code> is specified at the project level, then this <code>sourceVersion</code> (at the build level) takes precedence. </para><para>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>CodeBuild User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.CloudWatchLogs_Status"> <summary> <para> <para>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</para><ul><li><para><code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.S3Logs_Status"> <summary> <para> <para>The current status of the S3 build logs. Valid values are:</para><ul><li><para><code>ENABLED</code>: S3 build logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: S3 build logs are not enabled for this build project.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.CloudWatchLogs_StreamName"> <summary> <para> <para> The prefix of the stream name of the 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.BuildStatusConfigOverride_TargetUrl"> <summary> <para> <para>Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</para><dl><dt>Bitbucket</dt><dd><para>This parameter is used for the <code>url</code> parameter in the Bitbucket commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</para></dd><dt>GitHub/GitHub Enterprise Server</dt><dd><para>This parameter is used for the <code>target_url</code> parameter in the GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.TimeoutInMinutesOverride"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.ArtifactsOverride_Type"> <summary> <para> <para>The type of build output artifact. Valid values include:</para><ul><li><para><code>CODEPIPELINE</code>: The build project has build output generated through CodePipeline. </para><note><para>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</para></note></li><li><para><code>NO_ARTIFACTS</code>: The build project does not produce any build output.</para></li><li><para><code>S3</code>: The build project stores build output in Amazon S3.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.CacheOverride_Type"> <summary> <para> <para>The type of cache used by the build project. Valid values include:</para><ul><li><para><code>NO_CACHE</code>: The build project does not use any cache.</para></li><li><para><code>S3</code>: The build project reads and writes from and to S3.</para></li><li><para><code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.SourceAuthOverride_Type"> <summary> <para> <note><para> This data type is deprecated and is no longer accurate or used. </para></note><para>The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StartCBBuildCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.StopCBBatchCmdlet"> <summary> Stops a running batch build. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StopCBBatchCmdlet.Id"> <summary> <para> <para>The identifier of the batch build to stop.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StopCBBatchCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'BuildBatch'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.StopBuildBatchResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.StopBuildBatchResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StopCBBatchCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StopCBBatchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.StopCBBuildCmdlet"> <summary> Attempts to stop running a build. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StopCBBuildCmdlet.Id"> <summary> <para> <para>The ID of the build.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StopCBBuildCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StopCBBuildCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.StopCBBuildCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet"> <summary> Changes the settings of a build project. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_ArtifactIdentifier"> <summary> <para> <para> An identifier for this artifact definition. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.BadgeEnabled"> <summary> <para> <para>Set this to true to generate a publicly accessible URL for your project's build badge.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.BuildBatchConfig_BatchReportMode"> <summary> <para> <para>Specifies how build status reports are sent to the source provider for the batch build. This property is only used when the source provider for your project is Bitbucket, GitHub, or GitHub Enterprise, and your project is configured to report build statuses to the source provider.</para><dl><dt>REPORT_AGGREGATED_BATCH</dt><dd><para>(Default) Aggregate all of the build statuses into a single status report.</para></dd><dt>REPORT_INDIVIDUAL_BUILDS</dt><dd><para>Send a separate status report for each individual build.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_BucketOwnerAccess"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.S3Logs_BucketOwnerAccess"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Source_Buildspec"> <summary> <para> <para>The buildspec file declaration to use for the builds in this build project.</para><para> If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in <code>CODEBUILD_SRC_DIR</code> environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, <code>arn:aws:s3:::my-codebuild-sample2/buildspec.yml</code>). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage">Buildspec File Name and Storage Location</a>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Environment_Certificate"> <summary> <para> <para>The ARN of the Amazon S3 bucket, path prefix, and object key that contains the PEM-encoded certificate for the build project. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/create-project-cli.html#cli.environment.certificate">certificate</a> in the <i>CodeBuild User Guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.BuildBatchConfig_CombineArtifact"> <summary> <para> <para>Specifies if the build artifacts for the batch build should be combined into a single artifact location.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Environment_ComputeType"> <summary> <para> <para>Information about the compute resources the build project uses. Available values include:</para><ul><li><para><code>BUILD_GENERAL1_SMALL</code>: Use up to 3 GB memory and 2 vCPUs for builds.</para></li><li><para><code>BUILD_GENERAL1_MEDIUM</code>: Use up to 7 GB memory and 4 vCPUs for builds.</para></li><li><para><code>BUILD_GENERAL1_LARGE</code>: Use up to 16 GB memory and 8 vCPUs for builds, depending on your environment type.</para></li><li><para><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.</para></li><li><para><code>BUILD_LAMBDA_1GB</code>: Use up to 1 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li><li><para><code>BUILD_LAMBDA_2GB</code>: Use up to 2 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li><li><para><code>BUILD_LAMBDA_4GB</code>: Use up to 4 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li><li><para><code>BUILD_LAMBDA_8GB</code>: Use up to 8 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li><li><para><code>BUILD_LAMBDA_10GB</code>: Use up to 10 GB memory for builds. Only available for environment type <code>LINUX_LAMBDA_CONTAINER</code> and <code>ARM_LAMBDA_CONTAINER</code>.</para></li></ul><para> If you use <code>BUILD_GENERAL1_SMALL</code>: </para><ul><li><para> For environment type <code>LINUX_CONTAINER</code>, you can use up to 3 GB memory and 2 vCPUs for builds. </para></li><li><para> For environment type <code>LINUX_GPU_CONTAINER</code>, you can use up to 16 GB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.</para></li><li><para> For environment type <code>ARM_CONTAINER</code>, you can use up to 4 GB memory and 2 vCPUs on ARM-based processors for builds.</para></li></ul><para> If you use <code>BUILD_GENERAL1_LARGE</code>: </para><ul><li><para> For environment type <code>LINUX_CONTAINER</code>, you can use up to 15 GB memory and 8 vCPUs for builds. </para></li><li><para> 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.</para></li><li><para> For environment type <code>ARM_CONTAINER</code>, you can use up to 16 GB memory and 8 vCPUs on ARM-based processors for builds.</para></li></ul><para>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>CodeBuild User Guide.</i></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Restrictions_ComputeTypesAllowed"> <summary> <para> <para>An array of strings that specify the compute types that are allowed for the batch build. 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>CodeBuild User Guide</i> for these values. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.ConcurrentBuildLimit"> <summary> <para> <para>The maximum number of concurrent builds that are allowed for this project.</para><para>New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.</para><para>To remove this limit, set this value to -1.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.BuildStatusConfig_Context"> <summary> <para> <para>Specifies the context of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</para><dl><dt>Bitbucket</dt><dd><para>This parameter is used for the <code>name</code> parameter in the Bitbucket commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</para></dd><dt>GitHub/GitHub Enterprise Server</dt><dd><para>This parameter is used for the <code>context</code> parameter in the GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.RegistryCredential_Credential"> <summary> <para> <para> The Amazon Resource Name (ARN) or name of credentials created using Secrets Manager. </para><note><para> The <code>credential</code> can use the name of the credentials only if they exist in your current Amazon Web Services Region. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.RegistryCredential_CredentialProvider"> <summary> <para> <para> The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for Secrets Manager. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Description"> <summary> <para> <para>A new or replacement description of the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_EncryptionDisabled"> <summary> <para> <para> Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException is thrown. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.S3Logs_EncryptionDisabled"> <summary> <para> <para> Set to true if you do not want your S3 build log output encrypted. By default S3 build logs are encrypted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.EncryptionKey"> <summary> <para> <para>The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.</para><note><para> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </para></note><para>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Environment_EnvironmentVariable"> <summary> <para> <para>A set of environment variables to make available to builds for this build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.GitSubmodulesConfig_FetchSubmodule"> <summary> <para> <para> Set to true to fetch Git submodules for your CodeBuild build project. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.FileSystemLocation"> <summary> <para> <para> An array of <code>ProjectFileSystemLocation</code> objects for a CodeBuild build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Source_GitCloneDepth"> <summary> <para> <para>Information about the Git clone depth for the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.CloudWatchLogs_GroupName"> <summary> <para> <para> The group name of the logs in 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Environment_Image"> <summary> <para> <para>The image tag or image digest that identifies the Docker image to use for this build project. Use the following formats:</para><ul><li><para>For an image tag: <code><registry>/<repository>:<tag></code>. For example, in the Docker repository that CodeBuild uses to manage its Docker images, this would be <code>aws/codebuild/standard:4.0</code>. </para></li><li><para>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></li></ul><para>For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/build-env-ref-available.html">Docker images provided by CodeBuild</a> in the <i>CodeBuild user guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Environment_ImagePullCredentialsType"> <summary> <para> <para> The type of credentials CodeBuild uses to pull images in your build. There are two valid values: </para><ul><li><para><code>CODEBUILD</code> specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild service principal. </para></li><li><para><code>SERVICE_ROLE</code> specifies that CodeBuild uses your build project's service role. </para></li></ul><para> When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an CodeBuild curated image, you must use CODEBUILD credentials. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Source_InsecureSsl"> <summary> <para> <para>Enable this flag to ignore SSL warnings while connecting to the project source code.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_Location"> <summary> <para> <para>Information about the build output artifact location:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output locations instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, this is the name of the output bucket.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Cache_Location"> <summary> <para> <para>Information about the cache location: </para><ul><li><para><code>NO_CACHE</code> or <code>LOCAL</code>: This value is ignored.</para></li><li><para><code>S3</code>: This is the S3 bucket name/prefix.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.S3Logs_Location"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Source_Location"> <summary> <para> <para>Information about the location of the source code to be built. Valid values include:</para><ul><li><para>For source code settings that are specified in the source action of a pipeline in CodePipeline, <code>location</code> should not be specified. If it is specified, CodePipeline ignores it. This is because CodePipeline uses the settings in a pipeline's source action instead of this value.</para></li><li><para>For source code in an CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the buildspec file (for example, <code>https://git-codecommit.<region-ID>.amazonaws.com/v1/repos/<repo-name></code>).</para></li><li><para>For source code in an Amazon S3 input bucket, one of the following. </para><ul><li><para>The path to the ZIP file that contains the source code (for example, <code><bucket-name>/<path>/<object-name>.zip</code>). </para></li><li><para>The path to the folder that contains the source code (for example, <code><bucket-name>/<path-to-source-code>/<folder>/</code>). </para></li></ul></li><li><para>For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your GitHub account. Use the 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 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 CodeBuild console.) To instruct 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></li><li><para>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the buildspec file. You must connect your Amazon Web Services account to your Bitbucket account. Use the 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 CodeBuild console.) To instruct 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></li></ul><para> If you specify <code>CODEPIPELINE</code> for the <code>Type</code> property, don't specify this property. For all of the other types, you must specify <code>Location</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Restrictions_MaximumBuildsAllowed"> <summary> <para> <para>Specifies the maximum number of builds allowed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Cache_Mode"> <summary> <para> <para>An array of strings that specify the local cache modes. You can use one or more local cache modes at the same time. This is only used for <code>LOCAL</code> cache types.</para><para>Possible values are:</para><dl><dt>LOCAL_SOURCE_CACHE</dt><dd><para>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. </para></dd><dt>LOCAL_DOCKER_LAYER_CACHE</dt><dd><para>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. </para><note><ul><li><para>You can use a Docker layer cache in the Linux environment only. </para></li><li><para>The <code>privileged</code> flag must be set so that your project has the required Docker permissions. </para></li><li><para>You should consider the security implications before you use a Docker layer cache. </para></li></ul></note></dd><dt>LOCAL_CUSTOM_CACHE</dt><dd><para>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: </para><ul><li><para>Only directories can be specified for caching. You cannot specify individual files. </para></li><li><para>Symlinks are used to reference cached directories. </para></li><li><para>Cached directories are linked to your build before it downloads its project sources. Cached items are overridden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para></li></ul></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_Name"> <summary> <para> <para>Along with <code>path</code> and <code>namespaceType</code>, the pattern that CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>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.</para></li></ul><para>For example:</para><ul><li><para> 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/<build-ID>/MyArtifact.zip</code>. </para></li><li><para> 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. </para></li><li><para> 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/<build-ID></code>. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Name"> <summary> <para> <para>The name of the build project.</para><note><para>You cannot change a build project's name.</para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_NamespaceType"> <summary> <para> <para>Along with <code>path</code> and <code>name</code>, the pattern that CodeBuild uses to determine the name and location to store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, valid values include:</para><ul><li><para><code>BUILD_ID</code>: Include the build ID in the location of the build output artifact.</para></li><li><para><code>NONE</code>: Do not include the build ID. This is the default if <code>namespaceType</code> is not specified.</para></li></ul></li></ul><para>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/<build-ID>/MyArtifact.zip</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_OverrideArtifactName"> <summary> <para> <para> If this flag is set, a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_Packaging"> <summary> <para> <para>The type of build output artifact to create:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output artifacts instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>If <code>type</code> is set to <code>S3</code>, valid values include:</para><ul><li><para><code>NONE</code>: CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</para></li><li><para><code>ZIP</code>: CodeBuild creates in the output bucket a ZIP file that contains the build output.</para></li></ul></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_Path"> <summary> <para> <para>Along with <code>namespaceType</code> and <code>name</code>, the pattern that CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, CodePipeline ignores this value if specified. This is because CodePipeline manages its build output names instead of CodeBuild.</para></li><li><para>If <code>type</code> is set to <code>NO_ARTIFACTS</code>, this value is ignored if specified, because no build output is produced.</para></li><li><para>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.</para></li></ul><para>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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Environment_PrivilegedMode"> <summary> <para> <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>.</para><para>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:</para><para>If the operating system's base image is Ubuntu Linux:</para><para><code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code></para><para><code>- timeout 15 sh -c "until docker info; do echo .; sleep 1; done"</code></para><para>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>:</para><para><code>- nohup /usr/local/bin/dockerd --host=unix:///var/run/docker.sock --host=tcp://0.0.0.0:2375 --storage-driver=overlay&</code></para><para><code>- timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"</code></para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.QueuedTimeoutInMinute"> <summary> <para> <para> The number of minutes a build is allowed to be queued before it times out. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Source_ReportBuildStatus"> <summary> <para> <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 <code>invalidInputException</code> is thrown. </para><para>To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/access-tokens.html">Source provider access</a> in the <i>CodeBuild User Guide</i>.</para><para>The status of a build triggered by a webhook is always reported to your source provider. </para><para>If your project's builds are triggered by a webhook, you must push a new commit to the repo for a change to this property to take effect.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Auth_Resource"> <summary> <para> <para>The resource value that applies to the specified authorization type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.SecondaryArtifact"> <summary> <para> <para> An array of <code>ProjectArtifact</code> objects. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.SecondarySource"> <summary> <para> <para> An array of <code>ProjectSource</code> objects. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.SecondarySourceVersion"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.VpcConfig_SecurityGroupId"> <summary> <para> <para>A list of one or more security groups IDs in your Amazon VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.BuildBatchConfig_ServiceRole"> <summary> <para> <para>Specifies the service role ARN for the batch build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.ServiceRole"> <summary> <para> <para>The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Source_SourceIdentifier"> <summary> <para> <para>An identifier for this project source. The identifier can only contain alphanumeric characters and underscores, and must be less than 128 characters in length. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.SourceVersion"> <summary> <para> <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: </para><ul><li><para>For CodeCommit: the commit ID, branch, or Git tag to use.</para></li><li><para>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.</para></li><li><para>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.</para></li><li><para>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</para></li></ul><para> If <code>sourceVersion</code> is specified at the build level, then that version takes precedence over this <code>sourceVersion</code> (at the project level). </para><para> 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>CodeBuild User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.CloudWatchLogs_Status"> <summary> <para> <para>The current status of the logs in CloudWatch Logs for a build project. Valid values are:</para><ul><li><para><code>ENABLED</code>: CloudWatch Logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: CloudWatch Logs are not enabled for this build project.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.S3Logs_Status"> <summary> <para> <para>The current status of the S3 build logs. Valid values are:</para><ul><li><para><code>ENABLED</code>: S3 build logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: S3 build logs are not enabled for this build project.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.CloudWatchLogs_StreamName"> <summary> <para> <para> The prefix of the stream name of the 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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.VpcConfig_Subnet"> <summary> <para> <para>A list of one or more subnet IDs in your Amazon VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Tag"> <summary> <para> <para>An updated list of tag key and value pairs associated with this build project.</para><para>These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.BuildStatusConfig_TargetUrl"> <summary> <para> <para>Specifies the target url of the build status CodeBuild sends to the source provider. The usage of this parameter depends on the source provider.</para><dl><dt>Bitbucket</dt><dd><para>This parameter is used for the <code>url</code> parameter in the Bitbucket commit status. For more information, see <a href="https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Bworkspace%7D/%7Brepo_slug%7D/commit/%7Bnode%7D/statuses/build">build</a> in the Bitbucket API documentation.</para></dd><dt>GitHub/GitHub Enterprise Server</dt><dd><para>This parameter is used for the <code>target_url</code> parameter in the GitHub commit status. For more information, see <a href="https://developer.github.com/v3/repos/statuses/#create-a-commit-status">Create a commit status</a> in the GitHub developer guide.</para></dd></dl> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.BuildBatchConfig_TimeoutInMin"> <summary> <para> <para>Specifies the maximum amount of time, in minutes, that the batch build must be completed in.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.TimeoutInMinute"> <summary> <para> <para>The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Artifacts_Type"> <summary> <para> <para>The type of build output artifact. Valid values include:</para><ul><li><para><code>CODEPIPELINE</code>: The build project has build output generated through CodePipeline. </para><note><para>The <code>CODEPIPELINE</code> type is not supported for <code>secondaryArtifacts</code>.</para></note></li><li><para><code>NO_ARTIFACTS</code>: The build project does not produce any build output.</para></li><li><para><code>S3</code>: The build project stores build output in Amazon S3.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Cache_Type"> <summary> <para> <para>The type of cache used by the build project. Valid values include:</para><ul><li><para><code>NO_CACHE</code>: The build project does not use any cache.</para></li><li><para><code>S3</code>: The build project reads and writes from and to S3.</para></li><li><para><code>LOCAL</code>: The build project stores a cache locally on a build host that is only available to that build host.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Environment_Type"> <summary> <para> <para>The type of build environment to use for related builds.</para><ul><li><para>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).</para></li><li><para>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 (Ohio), 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></li><li><para>The environment type <code>LINUX_GPU_CONTAINER</code> is available only in regions US East (N. Virginia), US East (Ohio), 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></li></ul><ul><li><para>The environment types <code>ARM_LAMBDA_CONTAINER</code> and <code>LINUX_LAMBDA_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Mumbai), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), EU (Frankfurt), EU (Ireland), and South America (São Paulo).</para></li></ul><ul><li><para>The environment types <code>WINDOWS_CONTAINER</code> and <code>WINDOWS_SERVER_2019_CONTAINER</code> are available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and EU (Ireland).</para></li></ul><para>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>CodeBuild user guide</i>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Auth_Type"> <summary> <para> <note><para> This data type is deprecated and is no longer accurate or used. </para></note><para>The authorization type to use. The only valid value is <code>OAUTH</code>, which represents the OAuth authorization type.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Source_Type"> <summary> <para> <para>The type of repository that contains the source code to be built. Valid values include:</para><ul><li><para><code>BITBUCKET</code>: The source code is in a Bitbucket repository.</para></li><li><para><code>CODECOMMIT</code>: The source code is in an CodeCommit repository.</para></li><li><para><code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in CodePipeline.</para></li><li><para><code>GITHUB</code>: The source code is in a GitHub or GitHub Enterprise Cloud repository.</para></li><li><para><code>GITHUB_ENTERPRISE</code>: The source code is in a GitHub Enterprise Server repository.</para></li><li><para><code>NO_SOURCE</code>: The project does not have input source code.</para></li><li><para><code>S3</code>: The source code is in an Amazon S3 bucket.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.VpcConfig_VpcId"> <summary> <para> <para>The ID of the Amazon VPC.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectVisibilityCmdlet"> <summary> Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/public-builds.html">Public build projects</a> in the <i>CodeBuild User Guide</i>. <important><para> The following should be kept in mind when making your projects public: </para><ul><li><para> All of a project's build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public. </para></li><li><para> All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are: </para><ul><li><para> Do not store sensitive values in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values. </para></li><li><para> Follow <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/webhooks.html#webhook-best-practices">Best practices for using webhooks</a> in the <i>CodeBuild User Guide</i> to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible. </para></li></ul></li><li><para> A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded. </para></li></ul></important> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectVisibilityCmdlet.ProjectArn"> <summary> <para> <para>The Amazon Resource Name (ARN) of the build project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectVisibilityCmdlet.ProjectVisibility"> <summary> <para> The service has not provided documentation for this parameter; please refer to the service's API reference documentation for the latest available information. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectVisibilityCmdlet.ResourceAccessRole"> <summary> <para> <para>The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectVisibilityCmdlet.Select"> <summary> 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.UpdateProjectVisibilityResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.UpdateProjectVisibilityResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectVisibilityCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet"> <summary> Updates a report group. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.Arn"> <summary> <para> <para> The ARN of the report group to update. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.S3Destination_Bucket"> <summary> <para> <para> The name of the S3 bucket where the raw data of a report are exported. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.S3Destination_BucketOwner"> <summary> <para> <para>The Amazon Web Services account identifier of the owner of the Amazon S3 bucket. This allows report data to be exported to an Amazon S3 bucket that is owned by an account other than the account running the build.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.S3Destination_EncryptionDisabled"> <summary> <para> <para> A boolean value that specifies if the results of a report are encrypted. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.S3Destination_EncryptionKey"> <summary> <para> <para> The encryption key for the report's encrypted raw data. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.ExportConfig_ExportConfigType"> <summary> <para> <para> The export configuration type. Valid values are: </para><ul><li><para><code>S3</code>: The report results are exported to an S3 bucket. </para></li><li><para><code>NO_EXPORT</code>: The report results are not exported. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.S3Destination_Packaging"> <summary> <para> <para> The type of build output artifact to create. Valid values include: </para><ul><li><para><code>NONE</code>: CodeBuild creates the raw data in the output bucket. This is the default if packaging is not specified. </para></li><li><para><code>ZIP</code>: CodeBuild creates a ZIP file with the raw data in the output bucket. </para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.S3Destination_Path"> <summary> <para> <para> The path to the exported report's raw data results. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.Tag"> <summary> <para> <para> An updated list of tag key and value pairs associated with this report group. </para><para>These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ReportGroup'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.UpdateReportGroupResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.UpdateReportGroupResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBReportGroupCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.UpdateCBWebhookCmdlet"> <summary> Updates the webhook associated with an CodeBuild build project. <note><para> If you use Bitbucket for your repository, <code>rotateSecret</code> is ignored. </para></note> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBWebhookCmdlet.BranchFilter"> <summary> <para> <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.</para><note><para> It is recommended that you use <code>filterGroups</code> instead of <code>branchFilter</code>. </para></note> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBWebhookCmdlet.BuildType"> <summary> <para> <para>Specifies the type of build this webhook will trigger.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBWebhookCmdlet.FilterGroup"> <summary> <para> <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 contain at least one <code>EVENT</code><code>WebhookFilter</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBWebhookCmdlet.ProjectName"> <summary> <para> <para>The name of the CodeBuild project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBWebhookCmdlet.RotateSecret"> <summary> <para> <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> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBWebhookCmdlet.Select"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBWebhookCmdlet.PassThru"> <summary> 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. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBWebhookCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.WriteCBResourcePolicyCmdlet"> <summary> Stores a resource policy for the ARN of a <code>Project</code> or <code>ReportGroup</code> object. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.WriteCBResourcePolicyCmdlet.Policy"> <summary> <para> <para> A JSON-formatted resource policy. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/project-sharing.html#project-sharing-share">Sharing a Project</a> and <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/report-groups-sharing.html#report-groups-sharing-share">Sharing a Report Group</a> in the <i>CodeBuild User Guide</i>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.WriteCBResourcePolicyCmdlet.ResourceArn"> <summary> <para> <para> The ARN of the <code>Project</code> or <code>ReportGroup</code> resource you want to associate with a resource policy. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.WriteCBResourcePolicyCmdlet.Select"> <summary> Use the -Select parameter to control the cmdlet output. The default value is 'ResourceArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.CodeBuild.Model.PutResourcePolicyResponse). Specifying the name of a property of type Amazon.CodeBuild.Model.PutResourcePolicyResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.WriteCBResourcePolicyCmdlet.PassThru"> <summary> Changes the cmdlet behavior to return the value passed to the ResourceArn parameter. The -PassThru parameter is deprecated, use -Select '^ResourceArn' instead. This parameter will be removed in a future version. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.WriteCBResourcePolicyCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |