AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

ActionConfigurationProperty

import "github.com/aws/aws-sdk-go/service/codepipeline"

type ActionConfigurationProperty struct { Description *string `locationName:"description" min:"1" type:"string"` Key *bool `locationName:"key" type:"boolean" required:"true"` Name *string `locationName:"name" min:"1" type:"string" required:"true"` Queryable *bool `locationName:"queryable" type:"boolean"` Required *bool `locationName:"required" type:"boolean" required:"true"` Secret *bool `locationName:"secret" type:"boolean" required:"true"` Type *string `locationName:"type" type:"string" enum:"ActionConfigurationPropertyType"` }

Represents information about an action configuration property.

Description

Type: *string

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

Key

Type: *bool

Whether the configuration property is a key.

Key is a required field

Name

Type: *string

The name of the action configuration property.

Name is a required field

Queryable

Type: *bool

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.

Required

Type: *bool

Whether the configuration property is a required value.

Required is a required field

Secret

Type: *bool

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.

Secret is a required field

Type

Type: *string

The type of the configuration property.

Method

GoString

func (s ActionConfigurationProperty) GoString() string

GoString returns the string representation

SetDescription

func (s *ActionConfigurationProperty) SetDescription(v string) *ActionConfigurationProperty

SetDescription sets the Description field's value.

SetKey

func (s *ActionConfigurationProperty) SetKey(v bool) *ActionConfigurationProperty

SetKey sets the Key field's value.

SetName

func (s *ActionConfigurationProperty) SetName(v string) *ActionConfigurationProperty

SetName sets the Name field's value.

SetQueryable

func (s *ActionConfigurationProperty) SetQueryable(v bool) *ActionConfigurationProperty

SetQueryable sets the Queryable field's value.

SetRequired

func (s *ActionConfigurationProperty) SetRequired(v bool) *ActionConfigurationProperty

SetRequired sets the Required field's value.

SetSecret

func (s *ActionConfigurationProperty) SetSecret(v bool) *ActionConfigurationProperty

SetSecret sets the Secret field's value.

SetType

func (s *ActionConfigurationProperty) SetType(v string) *ActionConfigurationProperty

SetType sets the Type field's value.

String

func (s ActionConfigurationProperty) String() string

String returns the string representation

Validate

func (s *ActionConfigurationProperty) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: