Class BitBucketSourceActionProps
(deprecated) Construction properties for {@link BitBucketSourceAction}.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.CodePipeline.Actions
Assembly: Amazon.CDK.AWS.CodePipeline.Actions.dll
Syntax (csharp)
public class BitBucketSourceActionProps : Object, IBitBucketSourceActionProps, ICodeStarConnectionsSourceActionProps, ICommonAwsActionProps, ICommonActionProps
Syntax (vb)
Public Class BitBucketSourceActionProps
Inherits Object
Implements IBitBucketSourceActionProps, ICodeStarConnectionsSourceActionProps, ICommonAwsActionProps, ICommonActionProps
Remarks
Stability: Deprecated
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.CodePipeline;
using Amazon.CDK.AWS.CodePipeline.Actions;
using Amazon.CDK.AWS.IAM;
Artifact artifact;
Role role;
var bitBucketSourceActionProps = new BitBucketSourceActionProps {
ActionName = "actionName",
ConnectionArn = "connectionArn",
Output = artifact,
Owner = "owner",
Repo = "repo",
// the properties below are optional
Branch = "branch",
CodeBuildCloneOutput = false,
Role = role,
RunOrder = 123,
TriggerOnPush = false,
VariablesNamespace = "variablesNamespace"
};
Synopsis
Constructors
BitBucketSourceActionProps() |
Properties
ActionName | The physical, human-readable name of the Action. |
Branch | The branch to build. |
CodeBuildCloneOutput | Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building. |
ConnectionArn | The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository. |
Output | The output artifact that this action produces. |
Owner | The owning user or organization of the repository. |
Repo | The name of the repository. |
Role | The Role in which context's this Action will be executing in. |
RunOrder | The runOrder property for this Action. |
TriggerOnPush | Controls automatically starting your pipeline when a new commit is made on the configured repository and branch. |
VariablesNamespace | The name of the namespace to use for variables emitted by this action. |
Constructors
BitBucketSourceActionProps()
public BitBucketSourceActionProps()
Properties
ActionName
The physical, human-readable name of the Action.
public string ActionName { get; set; }
Property Value
System.String
Remarks
Note that Action names must be unique within a single Stage.
Branch
The branch to build.
public string Branch { get; set; }
Property Value
System.String
Remarks
Default: 'master'
CodeBuildCloneOutput
Whether the output should be the contents of the repository (which is the default), or a link that allows CodeBuild to clone the repository before building.
public Nullable<bool> CodeBuildCloneOutput { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Note: if this option is true, then only CodeBuild actions can use the resulting {@link output}.
Default: false
ConnectionArn
The ARN of the CodeStar Connection created in the AWS console that has permissions to access this GitHub or BitBucket repository.
public string ConnectionArn { get; set; }
Property Value
System.String
Remarks
Examples
"arn:aws:codestar-connections:us-east-1:123456789012:connection/12345678-abcd-12ab-34cdef5678gh";
Output
The output artifact that this action produces.
public Artifact_ Output { get; set; }
Property Value
Remarks
Can be used as input for further pipeline actions.
Owner
The owning user or organization of the repository.
public string Owner { get; set; }
Property Value
System.String
Examples
"aws";
Repo
The name of the repository.
public string Repo { get; set; }
Property Value
System.String
Examples
"aws-cdk";
Role
The Role in which context's this Action will be executing in.
public IRole Role { get; set; }
Property Value
Remarks
The Pipeline's Role will assume this Role (the required permissions for that will be granted automatically) right before executing this Action. This Action will be passed into your {@link IAction.bind} method in the {@link ActionBindOptions.role} property.
Default: a new Role will be generated
RunOrder
The runOrder property for this Action.
public Nullable<double> RunOrder { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
RunOrder determines the relative order in which multiple Actions in the same Stage execute.
Default: 1
See: https://docs.aws.amazon.com/codepipeline/latest/userguide/reference-pipeline-structure.html
TriggerOnPush
Controls automatically starting your pipeline when a new commit is made on the configured repository and branch.
public Nullable<bool> TriggerOnPush { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
If unspecified, the default value is true, and the field does not display by default.
Default: true
VariablesNamespace
The name of the namespace to use for variables emitted by this action.
public string VariablesNamespace { get; set; }
Property Value
System.String
Remarks
Default: - a name will be generated, based on the stage and action names, if any of the action's variables were referenced - otherwise, no namespace will be set