amazonka-route53-autonaming-2.0: Amazon Cloud Map SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

Description

Creates a public namespace based on DNS, which is visible on the internet. The namespace defines your service naming scheme. For example, if you name your namespace example.com and name your service backend, the resulting DNS name for the service is backend.example.com. You can discover instances that were registered with a public DNS namespace by using either a DiscoverInstances request or using DNS. For the current quota on the number of namespaces that you can create using the same Amazon Web Services account, see Cloud Map quotas in the Cloud Map Developer Guide.

The CreatePublicDnsNamespace API operation is not supported in the Amazon Web Services GovCloud (US) Regions.

Synopsis

Creating a Request

data CreatePublicDnsNamespace Source #

See: newCreatePublicDnsNamespace smart constructor.

Constructors

CreatePublicDnsNamespace' 

Fields

  • creatorRequestId :: Maybe Text

    A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

  • description :: Maybe Text

    A description for the namespace.

  • properties :: Maybe PublicDnsNamespaceProperties

    Properties for the public DNS namespace.

  • tags :: Maybe [Tag]

    The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

  • name :: Text

    The name that you want to assign to this namespace.

    Do not include sensitive information in the name. The name is publicly available using DNS queries.

Instances

Instances details
ToJSON CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

ToHeaders CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

ToPath CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

ToQuery CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

AWSRequest CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

Generic CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

Associated Types

type Rep CreatePublicDnsNamespace :: Type -> Type #

Read CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

Show CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

NFData CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

Eq CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

Hashable CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

type AWSResponse CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

type Rep CreatePublicDnsNamespace Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

type Rep CreatePublicDnsNamespace = D1 ('MetaData "CreatePublicDnsNamespace" "Amazonka.Route53AutoNaming.CreatePublicDnsNamespace" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "CreatePublicDnsNamespace'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creatorRequestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "properties") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PublicDnsNamespaceProperties)) :*: (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newCreatePublicDnsNamespace Source #

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

CreatePublicDnsNamespace, createPublicDnsNamespace_creatorRequestId - A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

CreatePublicDnsNamespace, createPublicDnsNamespace_description - A description for the namespace.

CreatePublicDnsNamespace, createPublicDnsNamespace_properties - Properties for the public DNS namespace.

$sel:tags:CreatePublicDnsNamespace', createPublicDnsNamespace_tags - The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

CreatePublicDnsNamespace, createPublicDnsNamespace_name - The name that you want to assign to this namespace.

Do not include sensitive information in the name. The name is publicly available using DNS queries.

Request Lenses

createPublicDnsNamespace_creatorRequestId :: Lens' CreatePublicDnsNamespace (Maybe Text) Source #

A unique string that identifies the request and that allows failed CreatePublicDnsNamespace requests to be retried without the risk of running the operation twice. CreatorRequestId can be any unique string (for example, a date/timestamp).

createPublicDnsNamespace_tags :: Lens' CreatePublicDnsNamespace (Maybe [Tag]) Source #

The tags to add to the namespace. Each tag consists of a key and an optional value that you define. Tags keys can be up to 128 characters in length, and tag values can be up to 256 characters in length.

createPublicDnsNamespace_name :: Lens' CreatePublicDnsNamespace Text Source #

The name that you want to assign to this namespace.

Do not include sensitive information in the name. The name is publicly available using DNS queries.

Destructuring the Response

data CreatePublicDnsNamespaceResponse Source #

See: newCreatePublicDnsNamespaceResponse smart constructor.

Constructors

CreatePublicDnsNamespaceResponse' 

Fields

Instances

Instances details
Generic CreatePublicDnsNamespaceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

Associated Types

type Rep CreatePublicDnsNamespaceResponse :: Type -> Type #

Read CreatePublicDnsNamespaceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

Show CreatePublicDnsNamespaceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

NFData CreatePublicDnsNamespaceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

Eq CreatePublicDnsNamespaceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

type Rep CreatePublicDnsNamespaceResponse Source # 
Instance details

Defined in Amazonka.Route53AutoNaming.CreatePublicDnsNamespace

type Rep CreatePublicDnsNamespaceResponse = D1 ('MetaData "CreatePublicDnsNamespaceResponse" "Amazonka.Route53AutoNaming.CreatePublicDnsNamespace" "amazonka-route53-autonaming-2.0-98MlwjLW1enGruUXoTOCqp" 'False) (C1 ('MetaCons "CreatePublicDnsNamespaceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "operationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreatePublicDnsNamespaceResponse Source #

Create a value of CreatePublicDnsNamespaceResponse 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:operationId:CreatePublicDnsNamespaceResponse', createPublicDnsNamespaceResponse_operationId - A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.

$sel:httpStatus:CreatePublicDnsNamespaceResponse', createPublicDnsNamespaceResponse_httpStatus - The response's http status code.

Response Lenses

createPublicDnsNamespaceResponse_operationId :: Lens' CreatePublicDnsNamespaceResponse (Maybe Text) Source #

A value that you can use to determine whether the request completed successfully. To get the status of the operation, see GetOperation.