CodeBuild / Client / update_project_visibility

update_project_visibility#

CodeBuild.Client.update_project_visibility(**kwargs)#

Changes the public visibility for a project. The project’s build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide.

Warning

The following should be kept in mind when making your projects public:

  • All of a project’s build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public.

  • All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are:

    • Do not store sensitive values, especially Amazon Web Services access key IDs and secret access keys, in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values.

    • Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible.

  • A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded.

See also: AWS API Documentation

Request Syntax

response = client.update_project_visibility(
    projectArn='string',
    projectVisibility='PUBLIC_READ'|'PRIVATE',
    resourceAccessRole='string'
)
Parameters:

  • projectArn (string) –

    [REQUIRED]

    The Amazon Resource Name (ARN) of the build project.

  • projectVisibility (string) –

    [REQUIRED]

    Specifies the visibility of the project’s builds. Possible values are:

    PUBLIC_READ

    The project builds are visible to the public.

    PRIVATE

    The project builds are not visible to the public.

  • resourceAccessRole (string) – The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project’s builds.

Return type:

dict

Returns:

Response Syntax

{
    'projectArn': 'string',
    'publicProjectAlias': 'string',
    'projectVisibility': 'PUBLIC_READ'|'PRIVATE'
}

Response Structure

  • (dict) –

    • projectArn (string) –

      The Amazon Resource Name (ARN) of the build project.

    • publicProjectAlias (string) –

      Contains the project identifier used with the public build APIs.

    • projectVisibility (string) –

      Specifies the visibility of the project’s builds. Possible values are:

      PUBLIC_READ

      The project builds are visible to the public.

      PRIVATE

      The project builds are not visible to the public.

Exceptions

  • CodeBuild.Client.exceptions.InvalidInputException

  • CodeBuild.Client.exceptions.ResourceNotFoundException