File: api_op_UpdateProjectVisibility.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.17.1-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 384,244 kB
  • sloc: java: 13,538; makefile: 400; sh: 137
file content (172 lines) | stat: -rw-r--r-- 6,025 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
// Code generated by smithy-go-codegen DO NOT EDIT.

package codebuild

import (
	"context"
	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
	"github.com/aws/aws-sdk-go-v2/service/codebuild/types"
	"github.com/aws/smithy-go/middleware"
	smithyhttp "github.com/aws/smithy-go/transport/http"
)

// 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
// (https://docs.aws.amazon.com/codebuild/latest/userguide/public-builds.html) 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
// (https://docs.aws.amazon.com/codebuild/latest/userguide/webhooks.html#webhook-best-practices)
// 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.
func (c *Client) UpdateProjectVisibility(ctx context.Context, params *UpdateProjectVisibilityInput, optFns ...func(*Options)) (*UpdateProjectVisibilityOutput, error) {
	if params == nil {
		params = &UpdateProjectVisibilityInput{}
	}

	result, metadata, err := c.invokeOperation(ctx, "UpdateProjectVisibility", params, optFns, c.addOperationUpdateProjectVisibilityMiddlewares)
	if err != nil {
		return nil, err
	}

	out := result.(*UpdateProjectVisibilityOutput)
	out.ResultMetadata = metadata
	return out, nil
}

type UpdateProjectVisibilityInput struct {

	// The Amazon Resource Name (ARN) of the build project.
	//
	// This member is required.
	ProjectArn *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.
	//
	// This member is required.
	ProjectVisibility types.ProjectVisibilityType

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

	noSmithyDocumentSerde
}

type UpdateProjectVisibilityOutput struct {

	// The Amazon Resource Name (ARN) of the build project.
	ProjectArn *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.
	ProjectVisibility types.ProjectVisibilityType

	// Contains the project identifier used with the public build APIs.
	PublicProjectAlias *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata

	noSmithyDocumentSerde
}

func (c *Client) addOperationUpdateProjectVisibilityMiddlewares(stack *middleware.Stack, options Options) (err error) {
	err = stack.Serialize.Add(&awsAwsjson11_serializeOpUpdateProjectVisibility{}, middleware.After)
	if err != nil {
		return err
	}
	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpUpdateProjectVisibility{}, middleware.After)
	if err != nil {
		return err
	}
	if err = addSetLoggerMiddleware(stack, options); err != nil {
		return err
	}
	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
		return err
	}
	if err = addResolveEndpointMiddleware(stack, options); err != nil {
		return err
	}
	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
		return err
	}
	if err = addRetryMiddlewares(stack, options); err != nil {
		return err
	}
	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
		return err
	}
	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
		return err
	}
	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
		return err
	}
	if err = addClientUserAgent(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
		return err
	}
	if err = addOpUpdateProjectVisibilityValidationMiddleware(stack); err != nil {
		return err
	}
	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opUpdateProjectVisibility(options.Region), middleware.Before); err != nil {
		return err
	}
	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
		return err
	}
	if err = addResponseErrorMiddleware(stack); err != nil {
		return err
	}
	if err = addRequestResponseLogging(stack, options); err != nil {
		return err
	}
	return nil
}

func newServiceMetadataMiddleware_opUpdateProjectVisibility(region string) *awsmiddleware.RegisterServiceMetadata {
	return &awsmiddleware.RegisterServiceMetadata{
		Region:        region,
		ServiceID:     ServiceID,
		SigningName:   "codebuild",
		OperationName: "UpdateProjectVisibility",
	}
}