com.pulumi.aws.codebuild.SourceCredential Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.codebuild;
import com.pulumi.aws.Utilities;
import com.pulumi.aws.codebuild.SourceCredentialArgs;
import com.pulumi.aws.codebuild.inputs.SourceCredentialState;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Export;
import com.pulumi.core.annotations.ResourceType;
import com.pulumi.core.internal.Codegen;
import java.lang.String;
import java.util.List;
import java.util.Optional;
import javax.annotation.Nullable;
/**
* Provides a CodeBuild Source Credentials Resource.
*
* > **NOTE:** [Codebuild only allows a single credential per given server type in a given region](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_codebuild.GitHubSourceCredentials.html). Therefore, when you define `aws.codebuild.SourceCredential`, `aws.codebuild.Project` resource defined in the same module will use it.
*
* ## Example Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.codebuild.SourceCredential;
* import com.pulumi.aws.codebuild.SourceCredentialArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var example = new SourceCredential("example", SourceCredentialArgs.builder()
* .authType("PERSONAL_ACCESS_TOKEN")
* .serverType("GITHUB")
* .token("example")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ### Bitbucket Server Usage
*
* <!--Start PulumiCodeChooser -->
*
* {@code
* package generated_program;
*
* import com.pulumi.Context;
* import com.pulumi.Pulumi;
* import com.pulumi.core.Output;
* import com.pulumi.aws.codebuild.SourceCredential;
* import com.pulumi.aws.codebuild.SourceCredentialArgs;
* import java.util.List;
* import java.util.ArrayList;
* import java.util.Map;
* import java.io.File;
* import java.nio.file.Files;
* import java.nio.file.Paths;
*
* public class App {
* public static void main(String[] args) {
* Pulumi.run(App::stack);
* }
*
* public static void stack(Context ctx) {
* var example = new SourceCredential("example", SourceCredentialArgs.builder()
* .authType("BASIC_AUTH")
* .serverType("BITBUCKET")
* .token("example")
* .userName("test-user")
* .build());
*
* }
* }
* }
*
* <!--End PulumiCodeChooser -->
*
* ## Import
*
* Using `pulumi import`, import CodeBuild Source Credential using the CodeBuild Source Credential arn. For example:
*
* ```sh
* $ pulumi import aws:codebuild/sourceCredential:SourceCredential example arn:aws:codebuild:us-west-2:123456789:token:github
* ```
*
*/
@ResourceType(type="aws:codebuild/sourceCredential:SourceCredential")
public class SourceCredential extends com.pulumi.resources.CustomResource {
/**
* The ARN of Source Credential.
*
*/
@Export(name="arn", refs={String.class}, tree="[0]")
private Output arn;
/**
* @return The ARN of Source Credential.
*
*/
public Output arn() {
return this.arn;
}
/**
* The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API.
*
*/
@Export(name="authType", refs={String.class}, tree="[0]")
private Output authType;
/**
* @return The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API.
*
*/
public Output authType() {
return this.authType;
}
/**
* The source provider used for this project.
*
*/
@Export(name="serverType", refs={String.class}, tree="[0]")
private Output serverType;
/**
* @return The source provider used for this project.
*
*/
public Output serverType() {
return this.serverType;
}
/**
* For `GitHub` or `GitHub Enterprise`, this is the personal access token. For `Bitbucket`, this is the app password.
*
*/
@Export(name="token", refs={String.class}, tree="[0]")
private Output token;
/**
* @return For `GitHub` or `GitHub Enterprise`, this is the personal access token. For `Bitbucket`, this is the app password.
*
*/
public Output token() {
return this.token;
}
/**
* The Bitbucket username when the authType is `BASIC_AUTH`. This parameter is not valid for other types of source providers or connections.
*
*/
@Export(name="userName", refs={String.class}, tree="[0]")
private Output userName;
/**
* @return The Bitbucket username when the authType is `BASIC_AUTH`. This parameter is not valid for other types of source providers or connections.
*
*/
public Output> userName() {
return Codegen.optional(this.userName);
}
/**
*
* @param name The _unique_ name of the resulting resource.
*/
public SourceCredential(String name) {
this(name, SourceCredentialArgs.Empty);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
*/
public SourceCredential(String name, SourceCredentialArgs args) {
this(name, args, null);
}
/**
*
* @param name The _unique_ name of the resulting resource.
* @param args The arguments to use to populate this resource's properties.
* @param options A bag of options that control this resource's behavior.
*/
public SourceCredential(String name, SourceCredentialArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:codebuild/sourceCredential:SourceCredential", name, args == null ? SourceCredentialArgs.Empty : args, makeResourceOptions(options, Codegen.empty()));
}
private SourceCredential(String name, Output id, @Nullable SourceCredentialState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
super("aws:codebuild/sourceCredential:SourceCredential", name, state, makeResourceOptions(options, id));
}
private static com.pulumi.resources.CustomResourceOptions makeResourceOptions(@Nullable com.pulumi.resources.CustomResourceOptions options, @Nullable Output id) {
var defaultOptions = com.pulumi.resources.CustomResourceOptions.builder()
.version(Utilities.getVersion())
.additionalSecretOutputs(List.of(
"token"
))
.build();
return com.pulumi.resources.CustomResourceOptions.merge(defaultOptions, options, id);
}
/**
* Get an existing Host resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state
* @param options Optional settings to control the behavior of the CustomResource.
*/
public static SourceCredential get(String name, Output id, @Nullable SourceCredentialState state, @Nullable com.pulumi.resources.CustomResourceOptions options) {
return new SourceCredential(name, id, state, options);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy