AWS.Tools.CodeBuild.XML
|
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.CodeBuild</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBBuildBatchCmdlet"> <summary> Gets information about 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="T:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListCmdlet"> <summary> Gets a list of build IDs, with each build ID representing a single build.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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>next token</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet"> <summary> Gets a list of build IDs for the specified build project, with each build ID representing a single build.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet.ProjectName"> <summary> <para> <para>The name of the AWS CodeBuild project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBBuildIdListForProjectCmdlet.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.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>next token</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBCuratedEnvironmentImageListCmdlet"> <summary> Gets information about Docker images that are managed by AWS CodeBuild. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBProjectBatchCmdlet"> <summary> Gets information about build projects. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.GetCBProjectBatchCmdlet.Name"> <summary> <para> <para>The names of the build projects.</para> </para> </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 operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </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>next token</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, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.GetCBSourceCredentialListCmdlet"> <summary> Returns a list of <code>SourceCredentialsInfo</code> objects. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.CB.ImportCBSourceCredentialCmdlet"> <summary> Imports the source repository credentials for an AWS 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 AWS 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.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.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.Source_Buildspec"> <summary> <para> <para>The build spec declaration to use for the builds in this build project.</para><para>If this value is not specified, a build spec must be included along with the source code to be built.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Environment_Certificate"> <summary> <para> <para>The certificate to use with this build project.</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 15 GB memory and 8 vCPUs for builds.</para></li></ul> </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 AWS Secrets Manager. </para><note><para> The <code>credential</code> can use the name of the credentials only if they exist in your current 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 AWS 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 Simple Storage Service (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 AWS Key Management Service (AWS KMS) 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/<i>alias-name</i></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 AWS CodeBuild build project. </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 Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </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, to specify an image with the tag "latest," use <code>registry/repository:latest</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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Environment_ImagePullCredentialsType"> <summary> <para> <para> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: </para><ul><li><para><code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. </para></li><li><para><code>SERVICE_ROLE</code> specifies that AWS 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 AWS 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>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS 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 AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</para></li><li><para>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i></code>).</para></li><li><para>For source code in an Amazon Simple Storage Service (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><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>). </para></li><li><para> The path to the folder that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>source-code</i>/<i>folder</i>/</code>). </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 build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to, and then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</para></li><li><para>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Cache_Mode"> <summary> <para> <para> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. </para><ul><li><para><code>LOCAL_SOURCE_CACHE</code> mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. </para></li><li><para><code>LOCAL_DOCKER_LAYER_CACHE</code> mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. </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></li></ul><ul><li><para><code>LOCAL_CUSTOM_CACHE</code> mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: </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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para></li></ul></li></ul> </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 AWS CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</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/<i>build-ID</i>/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/<i>build-ID</i></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 AWS 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>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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/<i>build-ID</i>/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 build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </para> </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>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS 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>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</para></li><li><para><code>ZIP</code>: AWS 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 AWS CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</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 be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</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 invalidInputException is thrown. </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.ServiceRole"> <summary> <para> <para>The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.NewCBProjectCmdlet.Source_SourceIdentifier"> <summary> <para> <para> An identifier for this project source. </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 AWS CodeCommit: the commit ID 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 Simple Storage Service (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>AWS 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 Amazon CloudWatch Logs for a build project. Valid values are:</para><ul><li><para><code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: Amazon 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 Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </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 set of tags for this build project.</para><para>These tags are available for use by AWS services that support AWS CodeBuild build project tags.</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 AWS 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 AWS CodePipeline.</para></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 Simple Storage Service (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> </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 AWS CodeCommit repository.</para></li><li><para><code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.</para></li><li><para><code>GITHUB</code>: The source code is in a GitHub 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 Simple Storage Service (Amazon S3) input 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.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 AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository. <important><para> If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console">Change a Build Project's Settings</a>. </para></important> </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.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 AWS CodeBuild project.</para> </para> </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.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.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. </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.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </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.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.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 AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBWebhookCmdlet.ProjectName"> <summary> <para> <para>The name of the AWS CodeBuild project.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.RemoveCBWebhookCmdlet.PassThru"> <summary> Returns the value passed to the ProjectName parameter. By default, this cmdlet does not generate any output. </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 AWS CodeBuild build project that the cache is reset for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.ResetCBProjectCacheCmdlet.PassThru"> <summary> Returns the value passed to the ProjectName parameter. By default, this cmdlet does not generate any output. </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.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.BuildspecOverride"> <summary> <para> <para>A build spec declaration that overrides, for this build only, the latest one already defined in the build project.</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.RegistryCredentialOverride_Credential"> <summary> <para> <para> The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager. </para><note><para> The <code>credential</code> can use the name of the credentials only if they exist in your current 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 AWS Secrets Manager. </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 Simple Storage Service (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.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 AWS 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 Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </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 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS 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 AWS CodeBuild uses to pull images in your build. There are two valid values: </para><ul><li><para><code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.</para></li><li><para><code>SERVICE_ROLE</code> specifies that AWS CodeBuild uses your build project's service role. </para></li></ul><para> When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials. </para> </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>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS 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> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. </para><ul><li><para><code>LOCAL_SOURCE_CACHE</code> mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. </para></li><li><para><code>LOCAL_DOCKER_LAYER_CACHE</code> mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. </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></li></ul><ul><li><para><code>LOCAL_CUSTOM_CACHE</code> mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: </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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para></li></ul></li></ul> </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 AWS CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</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/<i>build-ID</i>/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/<i>build-ID</i></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 AWS 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>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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/<i>build-ID</i>/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 build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </para> </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>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS 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>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</para></li><li><para><code>ZIP</code>: AWS 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 AWS CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</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 AWS 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 invalidInputException is thrown. </para> </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>A version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, must be one of:</para><ul><li><para>For AWS CodeCommit: the commit ID 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 Simple Storage Service (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 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>AWS 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 Amazon CloudWatch Logs for a build project. Valid values are:</para><ul><li><para><code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: Amazon 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 Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </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 AWS CodePipeline.</para></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 Simple Storage Service (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.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.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.Source_Buildspec"> <summary> <para> <para>The build spec declaration to use for the builds in this build project.</para><para>If this value is not specified, a build spec must be included along with the source code to be built.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Environment_Certificate"> <summary> <para> <para>The certificate to use with this build project.</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 15 GB memory and 8 vCPUs for builds.</para></li></ul> </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 AWS Secrets Manager. </para><note><para> The <code>credential</code> can use the name of the credentials only if they exist in your current 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 AWS 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 Simple Storage Service (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 AWS Key Management Service (AWS KMS) 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/<i>alias-name</i></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 AWS CodeBuild build project. </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 Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </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, to specify an image with the tag "latest," use <code>registry/repository:latest</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> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Environment_ImagePullCredentialsType"> <summary> <para> <para> The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values: </para><ul><li><para><code>CODEBUILD</code> specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal. </para></li><li><para><code>SERVICE_ROLE</code> specifies that AWS 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 AWS 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>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS 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 AWS CodePipeline, <code>location</code> should not be specified. If it is specified, AWS CodePipeline ignores it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value.</para></li><li><para>For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, <code>https://git-codecommit.<i>region-ID</i>.amazonaws.com/v1/repos/<i>repo-name</i></code>).</para></li><li><para>For source code in an Amazon Simple Storage Service (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><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>object-name</i>.zip</code>). </para></li><li><para> The path to the folder that contains the source code (for example, <code><i>bucket-name</i>/<i>path</i>/<i>to</i>/<i>source-code</i>/<i>folder</i>/</code>). </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 build spec. You must connect your AWS account to your GitHub account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub <b>Authorize application</b> page, for <b>Organization access</b>, choose <b>Request access</b> next to each repository you want to allow AWS CodeBuild to have access to, and then choose <b>Authorize application</b>. (After you have connected to your GitHub account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</para></li><li><para>For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. You must connect your AWS account to your Bitbucket account. Use the AWS CodeBuild console to start creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket <b>Confirm access to your account</b> page, choose <b>Grant access</b>. (After you have connected to your Bitbucket account, you do not need to finish creating the build project. You can leave the AWS CodeBuild console.) To instruct AWS CodeBuild to use this connection, in the <code>source</code> object, set the <code>auth</code> object's <code>type</code> value to <code>OAUTH</code>.</para></li></ul> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Cache_Mode"> <summary> <para> <para> If you use a <code>LOCAL</code> cache, the local cache mode. You can use one or more local cache modes at the same time. </para><ul><li><para><code>LOCAL_SOURCE_CACHE</code> mode caches Git metadata for primary and secondary sources. After the cache is created, subsequent builds pull only the change between commits. This mode is a good choice for projects with a clean working directory and a source that is a large Git repository. If you choose this option and your project does not use a Git repository (GitHub, GitHub Enterprise, or Bitbucket), the option is ignored. </para></li><li><para><code>LOCAL_DOCKER_LAYER_CACHE</code> mode caches existing Docker layers. This mode is a good choice for projects that build or pull large Docker images. It can prevent the performance issues caused by pulling large Docker images down from the network. </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></li></ul><ul><li><para><code>LOCAL_CUSTOM_CACHE</code> mode caches directories you specify in the buildspec file. This mode is a good choice if your build scenario is not suited to one of the other three local cache modes. If you use a custom cache: </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 overriden if a source item has the same name. Directories are specified using cache paths in the buildspec file. </para></li></ul></li></ul> </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 AWS CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</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/<i>build-ID</i>/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/<i>build-ID</i></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 AWS 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>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS 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/<i>build-ID</i>/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 build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique. </para> </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>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS 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>: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if <code>packaging</code> is not specified.</para></li><li><para><code>ZIP</code>: AWS 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 AWS CodeBuild uses to name and store the output artifact:</para><ul><li><para>If <code>type</code> is set to <code>CODEPIPELINE</code>, AWS CodePipeline ignores this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.</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 be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon fail. You must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run these commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)</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 invalidInputException is thrown. </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>ProjectSource</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.ServiceRole"> <summary> <para> <para>The replacement ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.CB.UpdateCBProjectCmdlet.Source_SourceIdentifier"> <summary> <para> <para> An identifier for this project source. </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 AWS CodeCommit: the commit ID 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 Simple Storage Service (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>AWS 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 Amazon CloudWatch Logs for a build project. Valid values are:</para><ul><li><para><code>ENABLED</code>: Amazon CloudWatch Logs are enabled for this build project.</para></li><li><para><code>DISABLED</code>: Amazon 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 Amazon CloudWatch Logs. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/Working-with-log-groups-and-streams.html">Working with Log Groups and Log Streams</a>. </para> </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>The replacement set of tags for this build project.</para><para>These tags are available for use by AWS services that support AWS CodeBuild build project tags.</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 AWS 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 AWS CodePipeline.</para></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 Simple Storage Service (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> </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 AWS CodeCommit repository.</para></li><li><para><code>CODEPIPELINE</code>: The source code settings are specified in the source action of a pipeline in AWS CodePipeline.</para></li><li><para><code>GITHUB</code>: The source code is in a GitHub 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 Simple Storage Service (Amazon S3) input 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.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 AWS 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.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 pcontain 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 AWS 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.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> |