| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Route53AutoNaming.CreatePrivateDnsNamespace
Description
Creates a private namespace based on DNS, which is visible only inside a
specified Amazon VPC. 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. Service instances that are registered using a
private DNS namespace can be discovered using either a
DiscoverInstances request or using DNS. For the current quota on the
number of namespaces that you can create using the same account, see
Cloud Map quotas
in the Cloud Map Developer Guide.
Synopsis
- data CreatePrivateDnsNamespace = CreatePrivateDnsNamespace' {
- creatorRequestId :: Maybe Text
- description :: Maybe Text
- tags :: Maybe [Tag]
- properties :: Maybe PrivateDnsNamespaceProperties
- name :: Text
- vpc :: Text
- newCreatePrivateDnsNamespace :: Text -> Text -> CreatePrivateDnsNamespace
- createPrivateDnsNamespace_creatorRequestId :: Lens' CreatePrivateDnsNamespace (Maybe Text)
- createPrivateDnsNamespace_description :: Lens' CreatePrivateDnsNamespace (Maybe Text)
- createPrivateDnsNamespace_tags :: Lens' CreatePrivateDnsNamespace (Maybe [Tag])
- createPrivateDnsNamespace_properties :: Lens' CreatePrivateDnsNamespace (Maybe PrivateDnsNamespaceProperties)
- createPrivateDnsNamespace_name :: Lens' CreatePrivateDnsNamespace Text
- createPrivateDnsNamespace_vpc :: Lens' CreatePrivateDnsNamespace Text
- data CreatePrivateDnsNamespaceResponse = CreatePrivateDnsNamespaceResponse' {
- operationId :: Maybe Text
- httpStatus :: Int
- newCreatePrivateDnsNamespaceResponse :: Int -> CreatePrivateDnsNamespaceResponse
- createPrivateDnsNamespaceResponse_operationId :: Lens' CreatePrivateDnsNamespaceResponse (Maybe Text)
- createPrivateDnsNamespaceResponse_httpStatus :: Lens' CreatePrivateDnsNamespaceResponse Int
Creating a Request
data CreatePrivateDnsNamespace Source #
See: newCreatePrivateDnsNamespace smart constructor.
Constructors
| CreatePrivateDnsNamespace' | |
Fields
| |
Instances
newCreatePrivateDnsNamespace Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreatePrivateDnsNamespace |
Create a value of CreatePrivateDnsNamespace 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:creatorRequestId:CreatePrivateDnsNamespace', createPrivateDnsNamespace_creatorRequestId - A unique string that identifies the request and that allows failed
CreatePrivateDnsNamespace requests to be retried without the risk of
running the operation twice. CreatorRequestId can be any unique string
(for example, a date/timestamp).
$sel:description:CreatePrivateDnsNamespace', createPrivateDnsNamespace_description - A description for the namespace.
$sel:tags:CreatePrivateDnsNamespace', createPrivateDnsNamespace_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.
$sel:properties:CreatePrivateDnsNamespace', createPrivateDnsNamespace_properties - Properties for the private DNS namespace.
$sel:name:CreatePrivateDnsNamespace', createPrivateDnsNamespace_name - The name that you want to assign to this namespace. When you create a
private DNS namespace, Cloud Map automatically creates an Amazon Route
53 private hosted zone that has the same name as the namespace.
$sel:vpc:CreatePrivateDnsNamespace', createPrivateDnsNamespace_vpc - The ID of the Amazon VPC that you want to associate the namespace with.
Request Lenses
createPrivateDnsNamespace_creatorRequestId :: Lens' CreatePrivateDnsNamespace (Maybe Text) Source #
A unique string that identifies the request and that allows failed
CreatePrivateDnsNamespace requests to be retried without the risk of
running the operation twice. CreatorRequestId can be any unique string
(for example, a date/timestamp).
createPrivateDnsNamespace_description :: Lens' CreatePrivateDnsNamespace (Maybe Text) Source #
A description for the namespace.
createPrivateDnsNamespace_tags :: Lens' CreatePrivateDnsNamespace (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.
createPrivateDnsNamespace_properties :: Lens' CreatePrivateDnsNamespace (Maybe PrivateDnsNamespaceProperties) Source #
Properties for the private DNS namespace.
createPrivateDnsNamespace_name :: Lens' CreatePrivateDnsNamespace Text Source #
The name that you want to assign to this namespace. When you create a private DNS namespace, Cloud Map automatically creates an Amazon Route 53 private hosted zone that has the same name as the namespace.
createPrivateDnsNamespace_vpc :: Lens' CreatePrivateDnsNamespace Text Source #
The ID of the Amazon VPC that you want to associate the namespace with.
Destructuring the Response
data CreatePrivateDnsNamespaceResponse Source #
See: newCreatePrivateDnsNamespaceResponse smart constructor.
Constructors
| CreatePrivateDnsNamespaceResponse' | |
Fields
| |
Instances
newCreatePrivateDnsNamespaceResponse Source #
Arguments
| :: Int | |
| -> CreatePrivateDnsNamespaceResponse |
Create a value of CreatePrivateDnsNamespaceResponse 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:CreatePrivateDnsNamespaceResponse', createPrivateDnsNamespaceResponse_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:CreatePrivateDnsNamespaceResponse', createPrivateDnsNamespaceResponse_httpStatus - The response's http status code.
Response Lenses
createPrivateDnsNamespaceResponse_operationId :: Lens' CreatePrivateDnsNamespaceResponse (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.
createPrivateDnsNamespaceResponse_httpStatus :: Lens' CreatePrivateDnsNamespaceResponse Int Source #
The response's http status code.