| 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.CloudFormation.SetTypeConfiguration
Description
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.
Synopsis
- data SetTypeConfiguration = SetTypeConfiguration' {}
- newSetTypeConfiguration :: Text -> SetTypeConfiguration
- setTypeConfiguration_configurationAlias :: Lens' SetTypeConfiguration (Maybe Text)
- setTypeConfiguration_type :: Lens' SetTypeConfiguration (Maybe ThirdPartyType)
- setTypeConfiguration_typeArn :: Lens' SetTypeConfiguration (Maybe Text)
- setTypeConfiguration_typeName :: Lens' SetTypeConfiguration (Maybe Text)
- setTypeConfiguration_configuration :: Lens' SetTypeConfiguration Text
- data SetTypeConfigurationResponse = SetTypeConfigurationResponse' {}
- newSetTypeConfigurationResponse :: Int -> SetTypeConfigurationResponse
- setTypeConfigurationResponse_configurationArn :: Lens' SetTypeConfigurationResponse (Maybe Text)
- setTypeConfigurationResponse_httpStatus :: Lens' SetTypeConfigurationResponse Int
Creating a Request
data SetTypeConfiguration Source #
See: newSetTypeConfiguration smart constructor.
Constructors
| SetTypeConfiguration' | |
Fields
| |
Instances
newSetTypeConfiguration Source #
Arguments
| :: Text | |
| -> 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) Source #
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) Source #
The type of extension.
Conditional: You must specify ConfigurationArn, or Type and
TypeName.
setTypeConfiguration_typeArn :: Lens' SetTypeConfiguration (Maybe Text) Source #
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) Source #
The name of the extension.
Conditional: You must specify ConfigurationArn, or Type and
TypeName.
setTypeConfiguration_configuration :: Lens' SetTypeConfiguration Text Source #
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 Source #
See: newSetTypeConfigurationResponse smart constructor.
Constructors
| SetTypeConfigurationResponse' | |
Fields
| |
Instances
newSetTypeConfigurationResponse Source #
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) Source #
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 Source #
The response's http status code.