Amazonka.CloudFormation.SetTypeConfiguration

Specifies the configuration data for a registered CloudFormation extension, in the given account and region.

To view the current configuration data for an extension, refer to the ConfigurationSchema element of DescribeType. For more information, see Configuring extensions at the account level in the CloudFormation User Guide.

It's strongly recommended that you use dynamic references to restrict sensitive configuration definitions, such as third-party credentials. For more details on dynamic references, see Using dynamic references to specify template values in the CloudFormation User Guide.

Creating a Request

data SetTypeConfiguration

See: newSetTypeConfiguration smart constructor.

Constructors

SetTypeConfiguration'

Fields

• configurationAlias :: Maybe Text

  An alias by which to refer to this extension configuration data.

  Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

• type' :: Maybe ThirdPartyType

  The type of extension.

  Conditional: You must specify ConfigurationArn, or Type and TypeName.

• typeArn :: Maybe Text

  The Amazon Resource Name (ARN) for the extension, in this account and region.

  For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

  Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

• typeName :: Maybe Text

  The name of the extension.

  Conditional: You must specify ConfigurationArn, or Type and TypeName.

• configuration :: Text

  The configuration data for the extension, in this account and region.

  The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of API_DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.

Instances

ToHeaders SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

toHeaders :: SetTypeConfiguration -> [Header]

ToPath SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

toPath :: SetTypeConfiguration -> ByteString

ToQuery SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

toQuery :: SetTypeConfiguration -> QueryString

AWSRequest SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Associated Types

type AWSResponse SetTypeConfiguration

Methods

request :: (Service -> Service) -> SetTypeConfiguration -> Request SetTypeConfiguration

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy SetTypeConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse SetTypeConfiguration)))

Generic SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Associated Types

type Rep SetTypeConfiguration :: Type -> Type

Methods

from :: SetTypeConfiguration -> Rep SetTypeConfiguration x

to :: Rep SetTypeConfiguration x -> SetTypeConfiguration

Read SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

readsPrec :: Int -> ReadS SetTypeConfiguration

readList :: ReadS [SetTypeConfiguration]

readPrec :: ReadPrec SetTypeConfiguration

readListPrec :: ReadPrec [SetTypeConfiguration]

Show SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

showsPrec :: Int -> SetTypeConfiguration -> ShowS

show :: SetTypeConfiguration -> String

showList :: [SetTypeConfiguration] -> ShowS

NFData SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

rnf :: SetTypeConfiguration -> ()

Eq SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

(==) :: SetTypeConfiguration -> SetTypeConfiguration -> Bool

(/=) :: SetTypeConfiguration -> SetTypeConfiguration -> Bool

Hashable SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

hashWithSalt :: Int -> SetTypeConfiguration -> Int

hash :: SetTypeConfiguration -> Int

type AWSResponse SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

type AWSResponse SetTypeConfiguration = SetTypeConfigurationResponse

type Rep SetTypeConfiguration

Defined in Amazonka.CloudFormation.SetTypeConfiguration

type Rep SetTypeConfiguration = D1 ('MetaData "SetTypeConfiguration" "Amazonka.CloudFormation.SetTypeConfiguration" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "SetTypeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "configurationAlias") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ThirdPartyType))) :*: (S1 ('MetaSel ('Just "typeArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "typeName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "configuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newSetTypeConfiguration

Arguments

:: Text

SetTypeConfiguration

-> SetTypeConfiguration

Create a value of SetTypeConfiguration 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:configurationAlias:SetTypeConfiguration', setTypeConfiguration_configurationAlias - An alias by which to refer to this extension configuration data.

Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

SetTypeConfiguration, setTypeConfiguration_type - The type of extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

SetTypeConfiguration, setTypeConfiguration_typeArn - The Amazon Resource Name (ARN) for the extension, in this account and region.

For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

SetTypeConfiguration, setTypeConfiguration_typeName - The name of the extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

SetTypeConfiguration, setTypeConfiguration_configuration - The configuration data for the extension, in this account and region.

The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of API_DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.

Request Lenses

setTypeConfiguration_configurationAlias :: Lens' SetTypeConfiguration (Maybe Text)

An alias by which to refer to this extension configuration data.

Conditional: Specifying a configuration alias is required when setting a configuration for a resource type extension.

setTypeConfiguration_type :: Lens' SetTypeConfiguration (Maybe ThirdPartyType)

The type of extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

setTypeConfiguration_typeArn :: Lens' SetTypeConfiguration (Maybe Text)

The Amazon Resource Name (ARN) for the extension, in this account and region.

For public extensions, this will be the ARN assigned when you activate the type in this account and region. For private extensions, this will be the ARN assigned when you register the type in this account and region.

Do not include the extension versions suffix at the end of the ARN. You can set the configuration for an extension, but not for a specific extension version.

setTypeConfiguration_typeName :: Lens' SetTypeConfiguration (Maybe Text)

The name of the extension.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

setTypeConfiguration_configuration :: Lens' SetTypeConfiguration Text

The configuration data for the extension, in this account and region.

The configuration data must be formatted as JSON, and validate against the schema returned in the ConfigurationSchema response element of API_DescribeType. For more information, see Defining account-level configuration data for an extension in the CloudFormation CLI User Guide.

Destructuring the Response

data SetTypeConfigurationResponse

See: newSetTypeConfigurationResponse smart constructor.

Constructors

SetTypeConfigurationResponse'

Fields

• configurationArn :: Maybe Text

  The Amazon Resource Name (ARN) for the configuration data, in this account and region.

  Conditional: You must specify ConfigurationArn, or Type and TypeName.

• httpStatus :: Int

  The response's http status code.

Instances

Generic SetTypeConfigurationResponse

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Associated Types

type Rep SetTypeConfigurationResponse :: Type -> Type

Methods

from :: SetTypeConfigurationResponse -> Rep SetTypeConfigurationResponse x

to :: Rep SetTypeConfigurationResponse x -> SetTypeConfigurationResponse

Read SetTypeConfigurationResponse

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

readsPrec :: Int -> ReadS SetTypeConfigurationResponse

readList :: ReadS [SetTypeConfigurationResponse]

readPrec :: ReadPrec SetTypeConfigurationResponse

readListPrec :: ReadPrec [SetTypeConfigurationResponse]

Show SetTypeConfigurationResponse

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

showsPrec :: Int -> SetTypeConfigurationResponse -> ShowS

show :: SetTypeConfigurationResponse -> String

showList :: [SetTypeConfigurationResponse] -> ShowS

NFData SetTypeConfigurationResponse

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

rnf :: SetTypeConfigurationResponse -> ()

Eq SetTypeConfigurationResponse

Defined in Amazonka.CloudFormation.SetTypeConfiguration

Methods

(==) :: SetTypeConfigurationResponse -> SetTypeConfigurationResponse -> Bool

(/=) :: SetTypeConfigurationResponse -> SetTypeConfigurationResponse -> Bool

type Rep SetTypeConfigurationResponse

Defined in Amazonka.CloudFormation.SetTypeConfiguration

type Rep SetTypeConfigurationResponse = D1 ('MetaData "SetTypeConfigurationResponse" "Amazonka.CloudFormation.SetTypeConfiguration" "amazonka-cloudformation-2.0-2g2oPzedi5AcwbDRlNZfB" 'False) (C1 ('MetaCons "SetTypeConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "configurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newSetTypeConfigurationResponse

Arguments

:: Int

$sel:httpStatus:SetTypeConfigurationResponse'

-> SetTypeConfigurationResponse

Create a value of SetTypeConfigurationResponse 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:configurationArn:SetTypeConfigurationResponse', setTypeConfigurationResponse_configurationArn - The Amazon Resource Name (ARN) for the configuration data, in this account and region.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

$sel:httpStatus:SetTypeConfigurationResponse', setTypeConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

setTypeConfigurationResponse_configurationArn :: Lens' SetTypeConfigurationResponse (Maybe Text)

The Amazon Resource Name (ARN) for the configuration data, in this account and region.

Conditional: You must specify ConfigurationArn, or Type and TypeName.

setTypeConfigurationResponse_httpStatus :: Lens' SetTypeConfigurationResponse Int

The response's http status code.