Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.CodePipeline.Types.ActionConfigurationProperty

Description

Synopsis

data ActionConfigurationProperty = ActionConfigurationProperty' {
- description :: Maybe Text
- queryable :: Maybe Bool
- type' :: Maybe ActionConfigurationPropertyType
- name :: Text
- required :: Bool
- key :: Bool
- secret :: Bool
}
newActionConfigurationProperty :: Text -> Bool -> Bool -> Bool -> ActionConfigurationProperty
actionConfigurationProperty_description :: Lens' ActionConfigurationProperty (Maybe Text)
actionConfigurationProperty_queryable :: Lens' ActionConfigurationProperty (Maybe Bool)
actionConfigurationProperty_type :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType)
actionConfigurationProperty_name :: Lens' ActionConfigurationProperty Text
actionConfigurationProperty_required :: Lens' ActionConfigurationProperty Bool
actionConfigurationProperty_key :: Lens' ActionConfigurationProperty Bool
actionConfigurationProperty_secret :: Lens' ActionConfigurationProperty Bool

Documentation

data ActionConfigurationProperty Source #

Represents information about an action configuration property.

See: newActionConfigurationProperty smart constructor.

Constructors

ActionConfigurationProperty'

Fields

description :: Maybe Text
The description of the action configuration property that is displayed to users.
queryable :: Maybe Bool
Indicates that the property is used 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 other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.
type' :: Maybe ActionConfigurationPropertyType
The type of the configuration property.
name :: Text
The name of the action configuration property.
required :: Bool
Whether the configuration property is a required value.
key :: Bool
Whether the configuration property is a key.
secret :: 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 preserves the previous value of the secret.

Instances

Instances details

FromJSON ActionConfigurationProperty Source #
Instance details Defined in Amazonka.CodePipeline.Types.ActionConfigurationProperty Methods parseJSON :: Value -> Parser ActionConfigurationProperty # parseJSONList :: Value -> Parser [ActionConfigurationProperty] #
ToJSON ActionConfigurationProperty Source #
Instance details Defined in Amazonka.CodePipeline.Types.ActionConfigurationProperty Methods toJSON :: ActionConfigurationProperty -> Value # toEncoding :: ActionConfigurationProperty -> Encoding # toJSONList :: [ActionConfigurationProperty] -> Value # toEncodingList :: [ActionConfigurationProperty] -> Encoding #
Generic ActionConfigurationProperty Source #
Instance details Defined in Amazonka.CodePipeline.Types.ActionConfigurationProperty Associated Types type Rep ActionConfigurationProperty :: Type -> Type # Methods from :: ActionConfigurationProperty -> Rep ActionConfigurationProperty x # to :: Rep ActionConfigurationProperty x -> ActionConfigurationProperty #
Read ActionConfigurationProperty Source #
Instance details Defined in Amazonka.CodePipeline.Types.ActionConfigurationProperty Methods readsPrec :: Int -> ReadS ActionConfigurationProperty # readList :: ReadS [ActionConfigurationProperty] # readPrec :: ReadPrec ActionConfigurationProperty # readListPrec :: ReadPrec [ActionConfigurationProperty] #
Show ActionConfigurationProperty Source #
Instance details Defined in Amazonka.CodePipeline.Types.ActionConfigurationProperty Methods showsPrec :: Int -> ActionConfigurationProperty -> ShowS # show :: ActionConfigurationProperty -> String # showList :: [ActionConfigurationProperty] -> ShowS #
NFData ActionConfigurationProperty Source #
Instance details Defined in Amazonka.CodePipeline.Types.ActionConfigurationProperty Methods rnf :: ActionConfigurationProperty -> () #
Eq ActionConfigurationProperty Source #
Instance details Defined in Amazonka.CodePipeline.Types.ActionConfigurationProperty Methods (==) :: ActionConfigurationProperty -> ActionConfigurationProperty -> Bool # (/=) :: ActionConfigurationProperty -> ActionConfigurationProperty -> Bool #
Hashable ActionConfigurationProperty Source #
Instance details Defined in Amazonka.CodePipeline.Types.ActionConfigurationProperty Methods hashWithSalt :: Int -> ActionConfigurationProperty -> Int # hash :: ActionConfigurationProperty -> Int #
type Rep ActionConfigurationProperty Source #
Instance details Defined in Amazonka.CodePipeline.Types.ActionConfigurationProperty type Rep ActionConfigurationProperty = D1 ('MetaData "ActionConfigurationProperty" "Amazonka.CodePipeline.Types.ActionConfigurationProperty" "amazonka-codepipeline-2.0-AHHPJTmnvhi1gPjRAFzjQE" 'False) (C1 ('MetaCons "ActionConfigurationProperty'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "queryable") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ActionConfigurationPropertyType)))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "required") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)) :: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "secret") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))

newActionConfigurationProperty Source #

Arguments

:: Text	`$sel:name:ActionConfigurationProperty'`
-> Bool	`$sel:required:ActionConfigurationProperty'`
-> Bool	`$sel:key:ActionConfigurationProperty'`
-> Bool	`$sel:secret:ActionConfigurationProperty'`
-> ActionConfigurationProperty

Create a value of ActionConfigurationProperty with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:description:ActionConfigurationProperty', actionConfigurationProperty_description - The description of the action configuration property that is displayed to users.

$sel:queryable:ActionConfigurationProperty', actionConfigurationProperty_queryable - Indicates that the property is used 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 other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

$sel:type':ActionConfigurationProperty', actionConfigurationProperty_type - The type of the configuration property.

$sel:name:ActionConfigurationProperty', actionConfigurationProperty_name - The name of the action configuration property.

$sel:required:ActionConfigurationProperty', actionConfigurationProperty_required - Whether the configuration property is a required value.

$sel:key:ActionConfigurationProperty', actionConfigurationProperty_key - Whether the configuration property is a key.

$sel:secret:ActionConfigurationProperty', actionConfigurationProperty_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 preserves the previous value of the secret.

actionConfigurationProperty_description :: Lens' ActionConfigurationProperty (Maybe Text) Source #

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

actionConfigurationProperty_queryable :: Lens' ActionConfigurationProperty (Maybe Bool) Source #

Indicates that the property is used 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 other restrictions. The value must be less than or equal to twenty (20) characters. The value can contain only alphanumeric characters, underscores, and hyphens.

actionConfigurationProperty_type :: Lens' ActionConfigurationProperty (Maybe ActionConfigurationPropertyType) Source #

The type of the configuration property.

actionConfigurationProperty_name :: Lens' ActionConfigurationProperty Text Source #

The name of the action configuration property.

actionConfigurationProperty_required :: Lens' ActionConfigurationProperty Bool Source #

Whether the configuration property is a required value.

actionConfigurationProperty_key :: Lens' ActionConfigurationProperty Bool Source #

Whether the configuration property is a key.

actionConfigurationProperty_secret :: Lens' ActionConfigurationProperty Bool Source #

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 preserves the previous value of the secret.