amazonka-codebuild-2.0: Amazon CodeBuild SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.CodeBuild.UpdateProjectVisibility

Description

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.

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

Creating a Request

data UpdateProjectVisibility Source #

See: newUpdateProjectVisibility smart constructor.

Constructors

UpdateProjectVisibility' 

Fields

Instances

Instances details
ToJSON UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

ToHeaders UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

ToPath UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

ToQuery UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

AWSRequest UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

Generic UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

Associated Types

type Rep UpdateProjectVisibility :: Type -> Type #

Read UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

Show UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

NFData UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

Methods

rnf :: UpdateProjectVisibility -> () #

Eq UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

Hashable UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

type AWSResponse UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

type Rep UpdateProjectVisibility Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

type Rep UpdateProjectVisibility = D1 ('MetaData "UpdateProjectVisibility" "Amazonka.CodeBuild.UpdateProjectVisibility" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "UpdateProjectVisibility'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceAccessRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "projectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "projectVisibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ProjectVisibilityType))))

newUpdateProjectVisibility Source #

Create a value of UpdateProjectVisibility with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateProjectVisibility, updateProjectVisibility_resourceAccessRole - The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

UpdateProjectVisibility, updateProjectVisibility_projectArn - The Amazon Resource Name (ARN) of the build project.

UpdateProjectVisibility, updateProjectVisibility_projectVisibility - Undocumented member.

Request Lenses

updateProjectVisibility_resourceAccessRole :: Lens' UpdateProjectVisibility (Maybe Text) Source #

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

updateProjectVisibility_projectArn :: Lens' UpdateProjectVisibility Text Source #

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

Destructuring the Response

data UpdateProjectVisibilityResponse Source #

See: newUpdateProjectVisibilityResponse smart constructor.

Constructors

UpdateProjectVisibilityResponse' 

Fields

Instances

Instances details
Generic UpdateProjectVisibilityResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

Associated Types

type Rep UpdateProjectVisibilityResponse :: Type -> Type #

Read UpdateProjectVisibilityResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

Show UpdateProjectVisibilityResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

NFData UpdateProjectVisibilityResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

Eq UpdateProjectVisibilityResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

type Rep UpdateProjectVisibilityResponse Source # 
Instance details

Defined in Amazonka.CodeBuild.UpdateProjectVisibility

type Rep UpdateProjectVisibilityResponse = D1 ('MetaData "UpdateProjectVisibilityResponse" "Amazonka.CodeBuild.UpdateProjectVisibility" "amazonka-codebuild-2.0-3KpZspRk9Ul8Wu4D0cM13Q" 'False) (C1 ('MetaCons "UpdateProjectVisibilityResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "projectArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "projectVisibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ProjectVisibilityType))) :*: (S1 ('MetaSel ('Just "publicProjectAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newUpdateProjectVisibilityResponse Source #

Create a value of UpdateProjectVisibilityResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

UpdateProjectVisibility, updateProjectVisibilityResponse_projectArn - The Amazon Resource Name (ARN) of the build project.

UpdateProjectVisibility, updateProjectVisibilityResponse_projectVisibility - Undocumented member.

UpdateProjectVisibilityResponse, updateProjectVisibilityResponse_publicProjectAlias - Contains the project identifier used with the public build APIs.

$sel:httpStatus:UpdateProjectVisibilityResponse', updateProjectVisibilityResponse_httpStatus - The response's http status code.

Response Lenses

updateProjectVisibilityResponse_projectArn :: Lens' UpdateProjectVisibilityResponse (Maybe Text) Source #

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

updateProjectVisibilityResponse_publicProjectAlias :: Lens' UpdateProjectVisibilityResponse (Maybe Text) Source #

Contains the project identifier used with the public build APIs.