software.amazon.awssdk.services.codepipeline.model

Interface ActionConfigurationProperty.Builder

All Superinterfaces:

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

Enclosing class:

ActionConfigurationProperty

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

Method Summary

Modifier and Type	Method and Description
ActionConfigurationProperty.Builder	description(String description) The description of the action configuration property that will be displayed to users.
ActionConfigurationProperty.Builder	key(Boolean key) Whether the configuration property is a key.
ActionConfigurationProperty.Builder	name(String name) The name of the action configuration property.
ActionConfigurationProperty.Builder	queryable(Boolean queryable) Indicates that the property will be used in conjunction with PollForJobs.
ActionConfigurationProperty.Builder	required(Boolean required) Whether the configuration property is a required value.
ActionConfigurationProperty.Builder	secret(Boolean secret) Whether the configuration property is secret.
ActionConfigurationProperty.Builder	type(ActionConfigurationPropertyType type) The type of the configuration property.
ActionConfigurationProperty.Builder	type(String type) The type of the configuration property.

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

sdkFields

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

copy

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

applyMutation, build

Method Detail

name

ActionConfigurationProperty.Builder name(String name)

The name of the action configuration property.

Parameters:

name - The name of the action configuration property.

Returns:

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

required

ActionConfigurationProperty.Builder required(Boolean required)

Whether the configuration property is a required value.

Parameters:

required - Whether the configuration property is a required value.

Returns:

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

key

ActionConfigurationProperty.Builder key(Boolean key)

Whether the configuration property is a key.

Parameters:

key - Whether the configuration property is a key.

Returns:

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

secret

ActionConfigurationProperty.Builder secret(Boolean secret)

Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.

Parameters:

secret - Whether the configuration property is secret. Secrets are hidden from all calls except for GetJobDetails, GetThirdPartyJobDetails, PollForJobs, and PollForThirdPartyJobs.

When updating a pipeline, passing * * * * * without changing any other values of the action will preserve the prior value of the secret.

Returns:

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

queryable

ActionConfigurationProperty.Builder queryable(Boolean queryable)

Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

Parameters:

queryable - Indicates that the property will be used in conjunction with PollForJobs. When creating a custom action, an action can have up to one queryable property. If it has one, that property must be both required and not secret.

If you create a pipeline with a custom action type, and that custom action contains a queryable property, the value for that configuration property is subject to additional restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

Returns:

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

description

ActionConfigurationProperty.Builder description(String description)

The description of the action configuration property that will be displayed to users.

Parameters:

description - The description of the action configuration property that will be displayed to users.

Returns:

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

type

ActionConfigurationProperty.Builder type(String type)

The type of the configuration property.

Parameters:

type - The type of the configuration property.

Returns:

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

See Also:

ActionConfigurationPropertyType, ActionConfigurationPropertyType

type

ActionConfigurationProperty.Builder type(ActionConfigurationPropertyType type)

The type of the configuration property.

Parameters:

type - The type of the configuration property.

Returns:

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

See Also:

ActionConfigurationPropertyType, ActionConfigurationPropertyType