Documentation
¶
Overview ¶
nolint: lll Package codebuild exports types, functions, subpackages for provisioning codebuild resources.
> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-aws) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-aws` repo](https://github.com/terraform-providers/terraform-provider-aws/issues).
Index ¶
- type Project
- func (r *Project) Arn() *pulumi.StringOutput
- func (r *Project) Artifacts() *pulumi.Output
- func (r *Project) BadgeEnabled() *pulumi.BoolOutput
- func (r *Project) BadgeUrl() *pulumi.StringOutput
- func (r *Project) BuildTimeout() *pulumi.IntOutput
- func (r *Project) Cache() *pulumi.Output
- func (r *Project) Description() *pulumi.StringOutput
- func (r *Project) EncryptionKey() *pulumi.StringOutput
- func (r *Project) Environment() *pulumi.Output
- func (r *Project) ID() *pulumi.IDOutput
- func (r *Project) LogsConfig() *pulumi.Output
- func (r *Project) Name() *pulumi.StringOutput
- func (r *Project) SecondaryArtifacts() *pulumi.ArrayOutput
- func (r *Project) SecondarySources() *pulumi.ArrayOutput
- func (r *Project) ServiceRole() *pulumi.StringOutput
- func (r *Project) Source() *pulumi.Output
- func (r *Project) Tags() *pulumi.MapOutput
- func (r *Project) URN() *pulumi.URNOutput
- func (r *Project) VpcConfig() *pulumi.Output
- type ProjectArgs
- type ProjectState
- type SourceCredential
- func (r *SourceCredential) Arn() *pulumi.StringOutput
- func (r *SourceCredential) AuthType() *pulumi.StringOutput
- func (r *SourceCredential) ID() *pulumi.IDOutput
- func (r *SourceCredential) ServerType() *pulumi.StringOutput
- func (r *SourceCredential) Token() *pulumi.StringOutput
- func (r *SourceCredential) URN() *pulumi.URNOutput
- func (r *SourceCredential) UserName() *pulumi.StringOutput
- type SourceCredentialArgs
- type SourceCredentialState
- type Webhook
- func (r *Webhook) BranchFilter() *pulumi.StringOutput
- func (r *Webhook) FilterGroups() *pulumi.ArrayOutput
- func (r *Webhook) ID() *pulumi.IDOutput
- func (r *Webhook) PayloadUrl() *pulumi.StringOutput
- func (r *Webhook) ProjectName() *pulumi.StringOutput
- func (r *Webhook) Secret() *pulumi.StringOutput
- func (r *Webhook) URN() *pulumi.URNOutput
- func (r *Webhook) Url() *pulumi.StringOutput
- type WebhookArgs
- type WebhookState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Project ¶
type Project struct {
// contains filtered or unexported fields
}
Provides a CodeBuild Project resource. See also the [`codebuild.Webhook` resource](https://www.terraform.io/docs/providers/aws/r/codebuild_webhook.html), which manages the webhook to the source (e.g. the "rebuild every time a code change is pushed" option in the CodeBuild web console).
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/codebuild_project.html.markdown.
func GetProject ¶
func GetProject(ctx *pulumi.Context, name string, id pulumi.ID, state *ProjectState, opts ...pulumi.ResourceOpt) (*Project, error)
GetProject gets an existing Project resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewProject ¶
func NewProject(ctx *pulumi.Context, name string, args *ProjectArgs, opts ...pulumi.ResourceOpt) (*Project, error)
NewProject registers a new resource with the given unique name, arguments, and options.
func (*Project) Arn ¶ added in v0.16.0
func (r *Project) Arn() *pulumi.StringOutput
The ARN of the CodeBuild project.
func (*Project) Artifacts ¶
Information about the project's build output artifacts. Artifact blocks are documented below.
func (*Project) BadgeEnabled ¶
func (r *Project) BadgeEnabled() *pulumi.BoolOutput
Generates a publicly-accessible URL for the projects build badge. Available as `badgeUrl` attribute when enabled.
func (*Project) BadgeUrl ¶
func (r *Project) BadgeUrl() *pulumi.StringOutput
The URL of the build badge when `badgeEnabled` is enabled.
func (*Project) BuildTimeout ¶
How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
func (*Project) Cache ¶
Information about the cache storage for the project. Cache blocks are documented below.
func (*Project) Description ¶
func (r *Project) Description() *pulumi.StringOutput
A short description of the project.
func (*Project) EncryptionKey ¶
func (r *Project) EncryptionKey() *pulumi.StringOutput
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts.
func (*Project) Environment ¶
Information about the project's build environment. Environment blocks are documented below.
func (*Project) LogsConfig ¶ added in v0.18.21
Configuration for the builds to store log data to CloudWatch or S3.
func (*Project) Name ¶
func (r *Project) Name() *pulumi.StringOutput
The name of the project. If `type` is set to `S3`, this is the name of the output artifact object
func (*Project) SecondaryArtifacts ¶ added in v0.16.0
func (r *Project) SecondaryArtifacts() *pulumi.ArrayOutput
A set of secondary artifacts to be used inside the build. Secondary artifacts blocks are documented below.
func (*Project) SecondarySources ¶ added in v0.16.0
func (r *Project) SecondarySources() *pulumi.ArrayOutput
A set of secondary sources to be used inside the build. Secondary sources blocks are documented below.
func (*Project) ServiceRole ¶
func (r *Project) ServiceRole() *pulumi.StringOutput
The Amazon Resource Name (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.
func (*Project) Source ¶
Information about the project's input source code. Source blocks are documented below.
type ProjectArgs ¶
type ProjectArgs struct { // Information about the project's build output artifacts. Artifact blocks are documented below. Artifacts interface{} // Generates a publicly-accessible URL for the projects build badge. Available as `badgeUrl` attribute when enabled. BadgeEnabled interface{} // How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes. BuildTimeout interface{} // Information about the cache storage for the project. Cache blocks are documented below. Cache interface{} // A short description of the project. Description interface{} // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts. EncryptionKey interface{} // Information about the project's build environment. Environment blocks are documented below. Environment interface{} // Configuration for the builds to store log data to CloudWatch or S3. LogsConfig interface{} // The name of the project. If `type` is set to `S3`, this is the name of the output artifact object Name interface{} // A set of secondary artifacts to be used inside the build. Secondary artifacts blocks are documented below. SecondaryArtifacts interface{} // A set of secondary sources to be used inside the build. Secondary sources blocks are documented below. SecondarySources interface{} // The Amazon Resource Name (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. ServiceRole interface{} // Information about the project's input source code. Source blocks are documented below. Source interface{} // A mapping of tags to assign to the resource. Tags interface{} // Configuration for the builds to run inside a VPC. VPC config blocks are documented below. VpcConfig interface{} }
The set of arguments for constructing a Project resource.
type ProjectState ¶
type ProjectState struct { // The ARN of the CodeBuild project. Arn interface{} // Information about the project's build output artifacts. Artifact blocks are documented below. Artifacts interface{} // Generates a publicly-accessible URL for the projects build badge. Available as `badgeUrl` attribute when enabled. BadgeEnabled interface{} // The URL of the build badge when `badgeEnabled` is enabled. BadgeUrl interface{} // How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes. BuildTimeout interface{} // Information about the cache storage for the project. Cache blocks are documented below. Cache interface{} // A short description of the project. Description interface{} // The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts. EncryptionKey interface{} // Information about the project's build environment. Environment blocks are documented below. Environment interface{} // Configuration for the builds to store log data to CloudWatch or S3. LogsConfig interface{} // The name of the project. If `type` is set to `S3`, this is the name of the output artifact object Name interface{} // A set of secondary artifacts to be used inside the build. Secondary artifacts blocks are documented below. SecondaryArtifacts interface{} // A set of secondary sources to be used inside the build. Secondary sources blocks are documented below. SecondarySources interface{} // The Amazon Resource Name (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. ServiceRole interface{} // Information about the project's input source code. Source blocks are documented below. Source interface{} // A mapping of tags to assign to the resource. Tags interface{} // Configuration for the builds to run inside a VPC. VPC config blocks are documented below. VpcConfig interface{} }
Input properties used for looking up and filtering Project resources.
type SourceCredential ¶ added in v0.18.26
type SourceCredential struct {
// contains filtered or unexported fields
}
Provides a CodeBuild Source Credentials Resource.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/codebuild_source_credential.html.markdown.
func GetSourceCredential ¶ added in v0.18.26
func GetSourceCredential(ctx *pulumi.Context, name string, id pulumi.ID, state *SourceCredentialState, opts ...pulumi.ResourceOpt) (*SourceCredential, error)
GetSourceCredential gets an existing SourceCredential resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewSourceCredential ¶ added in v0.18.26
func NewSourceCredential(ctx *pulumi.Context, name string, args *SourceCredentialArgs, opts ...pulumi.ResourceOpt) (*SourceCredential, error)
NewSourceCredential registers a new resource with the given unique name, arguments, and options.
func (*SourceCredential) Arn ¶ added in v0.18.26
func (r *SourceCredential) Arn() *pulumi.StringOutput
The ARN of Source Credential.
func (*SourceCredential) AuthType ¶ added in v0.18.26
func (r *SourceCredential) AuthType() *pulumi.StringOutput
The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API.
func (*SourceCredential) ID ¶ added in v0.18.26
func (r *SourceCredential) ID() *pulumi.IDOutput
ID is this resource's unique identifier assigned by its provider.
func (*SourceCredential) ServerType ¶ added in v0.18.26
func (r *SourceCredential) ServerType() *pulumi.StringOutput
The source provider used for this project.
func (*SourceCredential) Token ¶ added in v0.18.26
func (r *SourceCredential) Token() *pulumi.StringOutput
For `GitHub` or `GitHub Enterprise`, this is the personal access token. For `Bitbucket`, this is the app password.
func (*SourceCredential) URN ¶ added in v0.18.26
func (r *SourceCredential) URN() *pulumi.URNOutput
URN is this resource's unique name assigned by Pulumi.
func (*SourceCredential) UserName ¶ added in v0.18.26
func (r *SourceCredential) UserName() *pulumi.StringOutput
The Bitbucket username when the authType is `BASIC_AUTH`. This parameter is not valid for other types of source providers or connections.
type SourceCredentialArgs ¶ added in v0.18.26
type SourceCredentialArgs struct { // The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API. AuthType interface{} // The source provider used for this project. ServerType interface{} // For `GitHub` or `GitHub Enterprise`, this is the personal access token. For `Bitbucket`, this is the app password. Token interface{} // The Bitbucket username when the authType is `BASIC_AUTH`. This parameter is not valid for other types of source providers or connections. UserName interface{} }
The set of arguments for constructing a SourceCredential resource.
type SourceCredentialState ¶ added in v0.18.26
type SourceCredentialState struct { // The ARN of Source Credential. Arn interface{} // The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API. AuthType interface{} // The source provider used for this project. ServerType interface{} // For `GitHub` or `GitHub Enterprise`, this is the personal access token. For `Bitbucket`, this is the app password. Token interface{} // The Bitbucket username when the authType is `BASIC_AUTH`. This parameter is not valid for other types of source providers or connections. UserName interface{} }
Input properties used for looking up and filtering SourceCredential resources.
type Webhook ¶
type Webhook struct {
// contains filtered or unexported fields
}
Manages a CodeBuild webhook, which is an endpoint accepted by the CodeBuild service to trigger builds from source code repositories. Depending on the source type of the CodeBuild project, the CodeBuild service may also automatically create and delete the actual repository webhook as well.
> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/codebuild_webhook.html.markdown.
func GetWebhook ¶
func GetWebhook(ctx *pulumi.Context, name string, id pulumi.ID, state *WebhookState, opts ...pulumi.ResourceOpt) (*Webhook, error)
GetWebhook gets an existing Webhook resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).
func NewWebhook ¶
func NewWebhook(ctx *pulumi.Context, name string, args *WebhookArgs, opts ...pulumi.ResourceOpt) (*Webhook, error)
NewWebhook registers a new resource with the given unique name, arguments, and options.
func (*Webhook) BranchFilter ¶
func (r *Webhook) BranchFilter() *pulumi.StringOutput
A regular expression used to determine which branches get built. Default is all branches are built. It is recommended to use `filterGroup` over `branchFilter`.
func (*Webhook) FilterGroups ¶ added in v0.18.8
func (r *Webhook) FilterGroups() *pulumi.ArrayOutput
Information about the webhook's trigger. Filter group blocks are documented below.
func (*Webhook) PayloadUrl ¶
func (r *Webhook) PayloadUrl() *pulumi.StringOutput
The CodeBuild endpoint where webhook events are sent.
func (*Webhook) ProjectName ¶
func (r *Webhook) ProjectName() *pulumi.StringOutput
The name of the build project.
func (*Webhook) Secret ¶
func (r *Webhook) Secret() *pulumi.StringOutput
The secret token of the associated repository. Not returned by the CodeBuild API for all source types.
type WebhookArgs ¶
type WebhookArgs struct { // A regular expression used to determine which branches get built. Default is all branches are built. It is recommended to use `filterGroup` over `branchFilter`. BranchFilter interface{} // Information about the webhook's trigger. Filter group blocks are documented below. FilterGroups interface{} // The name of the build project. ProjectName interface{} }
The set of arguments for constructing a Webhook resource.
type WebhookState ¶
type WebhookState struct { // A regular expression used to determine which branches get built. Default is all branches are built. It is recommended to use `filterGroup` over `branchFilter`. BranchFilter interface{} // Information about the webhook's trigger. Filter group blocks are documented below. FilterGroups interface{} // The CodeBuild endpoint where webhook events are sent. PayloadUrl interface{} // The name of the build project. ProjectName interface{} // The secret token of the associated repository. Not returned by the CodeBuild API for all source types. Secret interface{} // The URL to the webhook. Url interface{} }
Input properties used for looking up and filtering Webhook resources.