Class: Aws::Route53::Types::CreateHostedZoneRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-route53/types.rb

Overview

Note:

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

{
  name: "DNSName", # required
  vpc: {
    vpc_region: "us-east-1", # accepts us-east-1, us-east-2, us-west-1, us-west-2, eu-west-1, eu-west-2, eu-west-3, eu-central-1, ap-east-1, me-south-1, us-gov-west-1, us-gov-east-1, us-iso-east-1, us-isob-east-1, ap-southeast-1, ap-southeast-2, ap-south-1, ap-northeast-1, ap-northeast-2, ap-northeast-3, eu-north-1, sa-east-1, ca-central-1, cn-north-1, af-south-1, eu-south-1
    vpc_id: "VPCId",
  },
  caller_reference: "Nonce", # required
  hosted_zone_config: {
    comment: "ResourceDescription",
    private_zone: false,
  },
  delegation_set_id: "ResourceId",
}

A complex type that contains information about the request to create a public or private hosted zone.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#caller_referenceString

A unique string that identifies the request and that allows failed `CreateHostedZone` requests to be retried without the risk of executing the operation twice. You must use a unique `CallerReference` string every time you submit a `CreateHostedZone` request. `CallerReference` can be any unique string, for example, a date/time stamp.

Returns:

  • (String)

1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'lib/aws-sdk-route53/types.rb', line 1247

class CreateHostedZoneRequest < Struct.new(
  :name,
  :vpc,
  :caller_reference,
  :hosted_zone_config,
  :delegation_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#delegation_set_idString

If you want to associate a reusable delegation set with this hosted zone, the ID that Amazon Route 53 assigned to the reusable delegation set when you created it. For more information about reusable delegation sets, see [CreateReusableDelegationSet].

[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_CreateReusableDelegationSet.html

Returns:

  • (String)

1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'lib/aws-sdk-route53/types.rb', line 1247

class CreateHostedZoneRequest < Struct.new(
  :name,
  :vpc,
  :caller_reference,
  :hosted_zone_config,
  :delegation_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#hosted_zone_configTypes::HostedZoneConfig

(Optional) A complex type that contains the following optional values:

  • For public and private hosted zones, an optional comment

  • For private hosted zones, an optional `PrivateZone` element

If you don't specify a comment or the `PrivateZone` element, omit `HostedZoneConfig` and the other elements.


1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'lib/aws-sdk-route53/types.rb', line 1247

class CreateHostedZoneRequest < Struct.new(
  :name,
  :vpc,
  :caller_reference,
  :hosted_zone_config,
  :delegation_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the domain. Specify a fully qualified domain name, for example, www.example.com. The trailing dot is optional; Amazon Route 53 assumes that the domain name is fully qualified. This means that Route 53 treats www.example.com (without a trailing dot) and www.example.com. (with a trailing dot) as identical.

If you're creating a public hosted zone, this is the name you have registered with your DNS registrar. If your domain name is registered with a registrar other than Route 53, change the name servers for your domain to the set of `NameServers` that `CreateHostedZone` returns in `DelegationSet`.

Returns:

  • (String)

1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'lib/aws-sdk-route53/types.rb', line 1247

class CreateHostedZoneRequest < Struct.new(
  :name,
  :vpc,
  :caller_reference,
  :hosted_zone_config,
  :delegation_set_id)
  SENSITIVE = []
  include Aws::Structure
end

#vpcTypes::VPC

(Private hosted zones only) A complex type that contains information about the Amazon VPC that you're associating with this hosted zone.

You can specify only one Amazon VPC when you create a private hosted zone. To associate additional Amazon VPCs with the hosted zone, use

AssociateVPCWithHostedZone][1

after you create a hosted zone.

[1]: docs.aws.amazon.com/Route53/latest/APIReference/API_AssociateVPCWithHostedZone.html

Returns:


1247
1248
1249
1250
1251
1252
1253
1254
1255
# File 'lib/aws-sdk-route53/types.rb', line 1247

class CreateHostedZoneRequest < Struct.new(
  :name,
  :vpc,
  :caller_reference,
  :hosted_zone_config,
  :delegation_set_id)
  SENSITIVE = []
  include Aws::Structure
end