Package com.pulumi.aws.codebuild
Class SourceCredential
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.codebuild.SourceCredential
-
public class SourceCredential extends com.pulumi.resources.CustomResourceProvides 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
### Bitbucket Server Usagepackage 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.ArrayList; import java.util.Arrays; 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()); } }
### AWS CodeStar Connection Usagepackage 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.ArrayList; import java.util.Arrays; 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()); } }
## Import ### Identity Schema #### Required - `arn` (String) ARN of the CodeBuild source credential. 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 ```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.ArrayList; import java.util.Arrays; 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("CODECONNECTIONS") .serverType("GITHUB") .token("arn:aws:codestar-connections:us-east-1:123456789012:connection/guid-string") .build()); } }
-
-
Constructor Summary
Constructors Constructor Description SourceCredential(java.lang.String name)SourceCredential(java.lang.String name, SourceCredentialArgs args)SourceCredential(java.lang.String name, SourceCredentialArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>arn()com.pulumi.core.Output<java.lang.String>authType()static SourceCredentialget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, SourceCredentialState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.lang.String>serverType()com.pulumi.core.Output<java.lang.String>token()com.pulumi.core.Output<java.util.Optional<java.lang.String>>userName()
-
-
-
Constructor Detail
-
SourceCredential
public SourceCredential(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
SourceCredential
public SourceCredential(java.lang.String name, SourceCredentialArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
SourceCredential
public SourceCredential(java.lang.String name, SourceCredentialArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- The ARN of Source Credential.
-
authType
public com.pulumi.core.Output<java.lang.String> authType()
- Returns:
- The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. Valid values are `BASIC_AUTH`, `PERSONAL_ACCESS_TOKEN`, `CODECONNECTIONS`, and `SECRETS_MANAGER`. An OAuth connection is not supported by the API.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
serverType
public com.pulumi.core.Output<java.lang.String> serverType()
- Returns:
- The source provider used for this project.
-
token
public com.pulumi.core.Output<java.lang.String> token()
- Returns:
- For a GitHub and GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password. When using an AWS CodeStar connection (`authType = "CODECONNECTIONS")`, this is an AWS CodeStar Connection ARN.
-
userName
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> userName()
- Returns:
- The Bitbucket username when the authType is `BASIC_AUTH`. This parameter is not valid for other types of source providers or connections.
-
get
public static SourceCredential get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable SourceCredentialState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-