Package software.amazon.awssdk.services.codepipeline.model

Interface RuleDeclaration.Builder

All Superinterfaces:

Buildable, CopyableBuilder<RuleDeclaration.Builder,RuleDeclaration>, SdkBuilder<RuleDeclaration.Builder,RuleDeclaration>, SdkPojo

Enclosing class:

RuleDeclaration

public static interface RuleDeclaration.Builder
extends SdkPojo, CopyableBuilder<RuleDeclaration.Builder,RuleDeclaration>

Method Summary

Modifier and Type	Method	Description
RuleDeclaration.Builder	commands(String... commands)	The shell commands to run with your commands rule in CodePipeline.
RuleDeclaration.Builder	commands(Collection<String> commands)	The shell commands to run with your commands rule in CodePipeline.
RuleDeclaration.Builder	configuration(Map<String,String> configuration)	The action configuration fields for the rule.
RuleDeclaration.Builder	inputArtifacts(Collection<InputArtifact> inputArtifacts)	The input artifacts fields for the rule, such as specifying an input file for the rule.
RuleDeclaration.Builder	inputArtifacts(Consumer<InputArtifact.Builder>... inputArtifacts)	The input artifacts fields for the rule, such as specifying an input file for the rule.
RuleDeclaration.Builder	inputArtifacts(InputArtifact... inputArtifacts)	The input artifacts fields for the rule, such as specifying an input file for the rule.
RuleDeclaration.Builder	name(String name)	The name of the rule that is created for the condition, such as VariableCheck.
RuleDeclaration.Builder	region(String region)	The Region for the condition associated with the rule.
RuleDeclaration.Builder	roleArn(String roleArn)	The pipeline role ARN associated with the rule.
default RuleDeclaration.Builder	ruleTypeId(Consumer<RuleTypeId.Builder> ruleTypeId)	The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
RuleDeclaration.Builder	ruleTypeId(RuleTypeId ruleTypeId)	The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.
RuleDeclaration.Builder	timeoutInMinutes(Integer timeoutInMinutes)	The action timeout for the rule.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

name

RuleDeclaration.Builder name(String name)

The name of the rule that is created for the condition, such as VariableCheck.

Parameters:

name - The name of the rule that is created for the condition, such as VariableCheck.

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleTypeId

RuleDeclaration.Builder ruleTypeId(RuleTypeId ruleTypeId)

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Parameters:

ruleTypeId - The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

Returns:

Returns a reference to this object so that method calls can be chained together.

ruleTypeId

default RuleDeclaration.Builder ruleTypeId(Consumer<RuleTypeId.Builder> ruleTypeId)

The ID for the rule type, which is made up of the combined values for category, owner, provider, and version.

This is a convenience method that creates an instance of the RuleTypeId.Builder avoiding the need to create one manually via RuleTypeId.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to ruleTypeId(RuleTypeId).

Parameters:

ruleTypeId - a consumer that will call methods on RuleTypeId.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

ruleTypeId(RuleTypeId)

configuration

RuleDeclaration.Builder configuration(Map<String,String> configuration)

The action configuration fields for the rule.

Parameters:

configuration - The action configuration fields for the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

commands

RuleDeclaration.Builder commands(Collection<String> commands)

The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

Using compute time for this action will incur separate charges in CodeBuild.

Parameters:

commands - The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

Using compute time for this action will incur separate charges in CodeBuild.

Returns:

Returns a reference to this object so that method calls can be chained together.

commands

RuleDeclaration.Builder commands(String... commands)

The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

Using compute time for this action will incur separate charges in CodeBuild.

Parameters:

commands - The shell commands to run with your commands rule in CodePipeline. All commands are supported except multi-line formats. While CodeBuild logs and permissions are used, you do not need to create any resources in CodeBuild.

Using compute time for this action will incur separate charges in CodeBuild.

Returns:

Returns a reference to this object so that method calls can be chained together.

inputArtifacts

RuleDeclaration.Builder inputArtifacts(Collection<InputArtifact> inputArtifacts)

The input artifacts fields for the rule, such as specifying an input file for the rule.

Parameters:

inputArtifacts - The input artifacts fields for the rule, such as specifying an input file for the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

inputArtifacts

RuleDeclaration.Builder inputArtifacts(InputArtifact... inputArtifacts)

The input artifacts fields for the rule, such as specifying an input file for the rule.

Parameters:

inputArtifacts - The input artifacts fields for the rule, such as specifying an input file for the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

inputArtifacts

RuleDeclaration.Builder inputArtifacts(Consumer<InputArtifact.Builder>... inputArtifacts)

The input artifacts fields for the rule, such as specifying an input file for the rule.

This is a convenience method that creates an instance of the InputArtifact.Builder avoiding the need to create one manually via InputArtifact.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #inputArtifacts(List).

Parameters:

inputArtifacts - a consumer that will call methods on InputArtifact.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#inputArtifacts(java.util.Collection)

roleArn

RuleDeclaration.Builder roleArn(String roleArn)

The pipeline role ARN associated with the rule.

Parameters:

roleArn - The pipeline role ARN associated with the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

region

RuleDeclaration.Builder region(String region)

The Region for the condition associated with the rule.

Parameters:

region - The Region for the condition associated with the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.

timeoutInMinutes

RuleDeclaration.Builder timeoutInMinutes(Integer timeoutInMinutes)

The action timeout for the rule.

Parameters:

timeoutInMinutes - The action timeout for the rule.

Returns:

Returns a reference to this object so that method calls can be chained together.