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.IoT.CreateDomainConfiguration

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a domain configuration.

Requires permission to access the CreateDomainConfiguration action.

Synopsis

Creating a Request

data CreateDomainConfiguration Source #

See: newCreateDomainConfiguration smart constructor.

Constructors

CreateDomainConfiguration'

Fields

authorizerConfig :: Maybe AuthorizerConfig
An object that specifies the authorization service for a domain.
domainName :: Maybe Text
The name of the domain.
serverCertificateArns :: Maybe [Text]
The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.
serviceType :: Maybe ServiceType
The type of service delivered by the endpoint.
Amazon Web Services IoT Core currently supports only the DATA service type.
tags :: Maybe [Tag]
Metadata which can be used to manage the domain configuration.
For URI Request parameters use format: ...key1=value1&key2=value2...
For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."
For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."
validationCertificateArn :: Maybe Text
The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.
domainConfigurationName :: Text
The name of the domain configuration. This value must be unique to a region.

Instances

Instances details

ToJSON CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods toJSON :: CreateDomainConfiguration -> Value # toEncoding :: CreateDomainConfiguration -> Encoding # toJSONList :: [CreateDomainConfiguration] -> Value # toEncodingList :: [CreateDomainConfiguration] -> Encoding #
ToHeaders CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods toHeaders :: CreateDomainConfiguration -> [Header] #
ToPath CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods toPath :: CreateDomainConfiguration -> ByteString #
ToQuery CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods toQuery :: CreateDomainConfiguration -> QueryString #
AWSRequest CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Associated Types type AWSResponse CreateDomainConfiguration # Methods request :: (Service -> Service) -> CreateDomainConfiguration -> Request CreateDomainConfiguration # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateDomainConfiguration -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateDomainConfiguration))) #
Generic CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Associated Types type Rep CreateDomainConfiguration :: Type -> Type # Methods from :: CreateDomainConfiguration -> Rep CreateDomainConfiguration x # to :: Rep CreateDomainConfiguration x -> CreateDomainConfiguration #
Read CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods readsPrec :: Int -> ReadS CreateDomainConfiguration # readList :: ReadS [CreateDomainConfiguration] # readPrec :: ReadPrec CreateDomainConfiguration # readListPrec :: ReadPrec [CreateDomainConfiguration] #
Show CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods showsPrec :: Int -> CreateDomainConfiguration -> ShowS # show :: CreateDomainConfiguration -> String # showList :: [CreateDomainConfiguration] -> ShowS #
NFData CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods rnf :: CreateDomainConfiguration -> () #
Eq CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods (==) :: CreateDomainConfiguration -> CreateDomainConfiguration -> Bool # (/=) :: CreateDomainConfiguration -> CreateDomainConfiguration -> Bool #
Hashable CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods hashWithSalt :: Int -> CreateDomainConfiguration -> Int # hash :: CreateDomainConfiguration -> Int #
type AWSResponse CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration type AWSResponse CreateDomainConfiguration = CreateDomainConfigurationResponse
type Rep CreateDomainConfiguration Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration type Rep CreateDomainConfiguration = D1 ('MetaData "CreateDomainConfiguration" "Amazonka.IoT.CreateDomainConfiguration" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateDomainConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authorizerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerConfig)) :: (S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "serverCertificateArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])))) :: ((S1 ('MetaSel ('Just "serviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceType)) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag]))) :: (S1 ('MetaSel ('Just "validationCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "domainConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreateDomainConfiguration Source #

Arguments

:: Text	`CreateDomainConfiguration`
-> CreateDomainConfiguration

Create a value of CreateDomainConfiguration 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:authorizerConfig:CreateDomainConfiguration', createDomainConfiguration_authorizerConfig - An object that specifies the authorization service for a domain.

$sel:domainName:CreateDomainConfiguration', createDomainConfiguration_domainName - The name of the domain.

$sel:serverCertificateArns:CreateDomainConfiguration', createDomainConfiguration_serverCertificateArns - The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.

CreateDomainConfiguration, createDomainConfiguration_serviceType - The type of service delivered by the endpoint.

Amazon Web Services IoT Core currently supports only the DATA service type.

$sel:tags:CreateDomainConfiguration', createDomainConfiguration_tags - Metadata which can be used to manage the domain configuration.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

$sel:validationCertificateArn:CreateDomainConfiguration', createDomainConfiguration_validationCertificateArn - The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.

CreateDomainConfiguration, createDomainConfiguration_domainConfigurationName - The name of the domain configuration. This value must be unique to a region.

Request Lenses

createDomainConfiguration_authorizerConfig :: Lens' CreateDomainConfiguration (Maybe AuthorizerConfig) Source #

An object that specifies the authorization service for a domain.

createDomainConfiguration_domainName :: Lens' CreateDomainConfiguration (Maybe Text) Source #

The name of the domain.

createDomainConfiguration_serverCertificateArns :: Lens' CreateDomainConfiguration (Maybe [Text]) Source #

The ARNs of the certificates that IoT passes to the device during the TLS handshake. Currently you can specify only one certificate ARN. This value is not required for Amazon Web Services-managed domains.

createDomainConfiguration_serviceType :: Lens' CreateDomainConfiguration (Maybe ServiceType) Source #

The type of service delivered by the endpoint.

Amazon Web Services IoT Core currently supports only the DATA service type.

createDomainConfiguration_tags :: Lens' CreateDomainConfiguration (Maybe [Tag]) Source #

Metadata which can be used to manage the domain configuration.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

createDomainConfiguration_validationCertificateArn :: Lens' CreateDomainConfiguration (Maybe Text) Source #

The certificate used to validate the server certificate and prove domain name ownership. This certificate must be signed by a public certificate authority. This value is not required for Amazon Web Services-managed domains.

createDomainConfiguration_domainConfigurationName :: Lens' CreateDomainConfiguration Text Source #

The name of the domain configuration. This value must be unique to a region.

Destructuring the Response

data CreateDomainConfigurationResponse Source #

See: newCreateDomainConfigurationResponse smart constructor.

Constructors

CreateDomainConfigurationResponse'
Fields domainConfigurationArn :: Maybe Text The ARN of the domain configuration. domainConfigurationName :: Maybe Text The name of the domain configuration. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateDomainConfigurationResponse Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Associated Types type Rep CreateDomainConfigurationResponse :: Type -> Type # Methods from :: CreateDomainConfigurationResponse -> Rep CreateDomainConfigurationResponse x # to :: Rep CreateDomainConfigurationResponse x -> CreateDomainConfigurationResponse #
Read CreateDomainConfigurationResponse Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods readsPrec :: Int -> ReadS CreateDomainConfigurationResponse # readList :: ReadS [CreateDomainConfigurationResponse] # readPrec :: ReadPrec CreateDomainConfigurationResponse # readListPrec :: ReadPrec [CreateDomainConfigurationResponse] #
Show CreateDomainConfigurationResponse Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods showsPrec :: Int -> CreateDomainConfigurationResponse -> ShowS # show :: CreateDomainConfigurationResponse -> String # showList :: [CreateDomainConfigurationResponse] -> ShowS #
NFData CreateDomainConfigurationResponse Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods rnf :: CreateDomainConfigurationResponse -> () #
Eq CreateDomainConfigurationResponse Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration Methods (==) :: CreateDomainConfigurationResponse -> CreateDomainConfigurationResponse -> Bool # (/=) :: CreateDomainConfigurationResponse -> CreateDomainConfigurationResponse -> Bool #
type Rep CreateDomainConfigurationResponse Source #
Instance details Defined in Amazonka.IoT.CreateDomainConfiguration type Rep CreateDomainConfigurationResponse = D1 ('MetaData "CreateDomainConfigurationResponse" "Amazonka.IoT.CreateDomainConfiguration" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "CreateDomainConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "domainConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateDomainConfigurationResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateDomainConfigurationResponse'`
-> CreateDomainConfigurationResponse

Create a value of CreateDomainConfigurationResponse 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:

CreateDomainConfigurationResponse, createDomainConfigurationResponse_domainConfigurationArn - The ARN of the domain configuration.

CreateDomainConfiguration, createDomainConfigurationResponse_domainConfigurationName - The name of the domain configuration.

$sel:httpStatus:CreateDomainConfigurationResponse', createDomainConfigurationResponse_httpStatus - The response's http status code.

Response Lenses

createDomainConfigurationResponse_domainConfigurationArn :: Lens' CreateDomainConfigurationResponse (Maybe Text) Source #

The ARN of the domain configuration.

createDomainConfigurationResponse_domainConfigurationName :: Lens' CreateDomainConfigurationResponse (Maybe Text) Source #

The name of the domain configuration.

createDomainConfigurationResponse_httpStatus :: Lens' CreateDomainConfigurationResponse Int Source #

The response's http status code.