libZSservicesZSamazonka-iotZSamazonka-iot
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.IoT.CreateDomainConfiguration

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.

  • 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.

  • domainName :: Maybe Text

    The name of the domain.

  • serviceType :: Maybe ServiceType

    The type of service delivered by the endpoint.

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

  • 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.

  • 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..."

  • domainConfigurationName :: Text

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

Instances

Instances details
Eq CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

Read CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

Show CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

Generic CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

Associated Types

type Rep CreateDomainConfiguration :: Type -> Type #

NFData CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

Hashable CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

ToJSON CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

AWSRequest CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

ToHeaders CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

ToPath CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

ToQuery CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

type Rep CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

type Rep CreateDomainConfiguration = D1 ('MetaData "CreateDomainConfiguration" "Amazonka.IoT.CreateDomainConfiguration" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "CreateDomainConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "authorizerConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuthorizerConfig)) :*: (S1 ('MetaSel ('Just "serverCertificateArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "domainName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "serviceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ServiceType)) :*: S1 ('MetaSel ('Just "validationCertificateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "domainConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateDomainConfiguration Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

newCreateDomainConfiguration Source #

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: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.

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

$sel:serviceType:CreateDomainConfiguration', createDomainConfiguration_serviceType - The type of service delivered by the endpoint.

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

$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.

$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:domainConfigurationName: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_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_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_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_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

Instances

Instances details
Eq CreateDomainConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

Read CreateDomainConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

Show CreateDomainConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

Generic CreateDomainConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

Associated Types

type Rep CreateDomainConfigurationResponse :: Type -> Type #

NFData CreateDomainConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

type Rep CreateDomainConfigurationResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateDomainConfiguration

type Rep CreateDomainConfigurationResponse = D1 ('MetaData "CreateDomainConfigurationResponse" "Amazonka.IoT.CreateDomainConfiguration" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "CreateDomainConfigurationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "domainConfigurationName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "domainConfigurationArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateDomainConfigurationResponse Source #

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:

$sel:domainConfigurationName:CreateDomainConfiguration', createDomainConfigurationResponse_domainConfigurationName - The name of the domain configuration.

$sel:domainConfigurationArn:CreateDomainConfigurationResponse', createDomainConfigurationResponse_domainConfigurationArn - The ARN of the domain configuration.

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

Response Lenses