Class: Aws::ServiceDiscovery::Types::CreatePrivateDnsNamespaceRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb

Overview

Note:

When making an API call, you may pass CreatePrivateDnsNamespaceRequest data as a hash:

{
  name: "NamespaceNamePrivate", # required
  creator_request_id: "ResourceId",
  description: "ResourceDescription",
  vpc: "ResourceId", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  properties: {
    dns_properties: { # required
      soa: { # required
        ttl: 1, # required
      },
    },
  },
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#creator_request_idString

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


144
145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 144

class CreatePrivateDnsNamespaceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :vpc,
  :tags,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description for the namespace.

Returns:

  • (String)


144
145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 144

class CreatePrivateDnsNamespaceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :vpc,
  :tags,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

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.

Returns:

  • (String)


144
145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 144

class CreatePrivateDnsNamespaceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :vpc,
  :tags,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#propertiesTypes::PrivateDnsNamespaceProperties

Properties for the private DNS namespace.



144
145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 144

class CreatePrivateDnsNamespaceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :vpc,
  :tags,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::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.

Returns:



144
145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 144

class CreatePrivateDnsNamespaceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :vpc,
  :tags,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end

#vpcString

The ID of the Amazon VPC that you want to associate the namespace with.

Returns:

  • (String)


144
145
146
147
148
149
150
151
152
153
# File 'gems/aws-sdk-servicediscovery/lib/aws-sdk-servicediscovery/types.rb', line 144

class CreatePrivateDnsNamespaceRequest < Struct.new(
  :name,
  :creator_request_id,
  :description,
  :vpc,
  :tags,
  :properties)
  SENSITIVE = []
  include Aws::Structure
end