RecordsExclusive class
Resource for maintaining exclusive management of resource record sets defined in an AWS Route53 hosted zone.
> This resource takes exclusive ownership over resource record sets defined in a hosted zone. This includes removal of record sets which are not explicitly configured. To prevent persistent drift, ensure any aws.route53.Record resources managed alongside this resource have an equivalent resourceRecordSet argument.
> Destruction of this resource means Terraform will no longer manage reconciliation of the configured resource record sets. It will not delete the configured record sets from the hosted zone.
> The default NS and SOA records created during provisioning of the Route53 Zone should not be included in this resource definition. Adding them will cause persistent drift as the read operation is explicitly configured to ignore writing them to state.
Example Usage
Basic Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.route53.Zone("example", {
name: "example.com",
forceDestroy: true,
});
const test = new aws.route53.RecordsExclusive("test", {
resourceRecordSets: [{
resourceRecords: [
{
value: "127.0.0.1",
},
{
value: "127.0.0.27",
},
],
name: "subdomain.example.com",
type: "A",
ttl: 30,
}],
zoneId: testAwsRoute53Zone.zoneId,
});
import pulumi
import pulumi_aws as aws
example = aws.route53.Zone("example",
name="example.com",
force_destroy=True)
test = aws.route53.RecordsExclusive("test",
resource_record_sets=[{
"resource_records": [
{
"value": "127.0.0.1",
},
{
"value": "127.0.0.27",
},
],
"name": "subdomain.example.com",
"type": "A",
"ttl": 30,
}],
zone_id=test_aws_route53_zone["zoneId"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.Route53.Zone("example", new()
{
Name = "example.com",
ForceDestroy = true,
});
var test = new Aws.Route53.RecordsExclusive("test", new()
{
ResourceRecordSets = new[]
{
new Aws.Route53.Inputs.RecordsExclusiveResourceRecordSetArgs
{
ResourceRecords = new[]
{
new Aws.Route53.Inputs.RecordsExclusiveResourceRecordSetResourceRecordArgs
{
Value = "127.0.0.1",
},
new Aws.Route53.Inputs.RecordsExclusiveResourceRecordSetResourceRecordArgs
{
Value = "127.0.0.27",
},
},
Name = "subdomain.example.com",
Type = "A",
Ttl = 30,
},
},
ZoneId = testAwsRoute53Zone.ZoneId,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := route53.NewZone(ctx, "example", &route53.ZoneArgs{
Name: pulumi.String("example.com"),
ForceDestroy: pulumi.Bool(true),
})
if err != nil {
return err
}
_, err = route53.NewRecordsExclusive(ctx, "test", &route53.RecordsExclusiveArgs{
ResourceRecordSets: route53.RecordsExclusiveResourceRecordSetArray{
&route53.RecordsExclusiveResourceRecordSetArgs{
ResourceRecords: route53.RecordsExclusiveResourceRecordSetResourceRecordArray{
&route53.RecordsExclusiveResourceRecordSetResourceRecordArgs{
Value: pulumi.String("127.0.0.1"),
},
&route53.RecordsExclusiveResourceRecordSetResourceRecordArgs{
Value: pulumi.String("127.0.0.27"),
},
},
Name: pulumi.String("subdomain.example.com"),
Type: pulumi.String("A"),
Ttl: pulumi.Int(30),
},
},
ZoneId: pulumi.Any(testAwsRoute53Zone.ZoneId),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_route53_zone" "example" {
name = "example.com"
force_destroy = true
}
resource "aws_route53_recordsexclusive" "test" {
resource_record_sets {
resource_records {
value = "127.0.0.1"
}
resource_records {
value = "127.0.0.27"
}
name = "subdomain.example.com"
type = "A"
ttl = "30"
}
zone_id = testAwsRoute53Zone.zoneId
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.Zone;
import com.pulumi.aws.route53.ZoneArgs;
import com.pulumi.aws.route53.RecordsExclusive;
import com.pulumi.aws.route53.RecordsExclusiveArgs;
import com.pulumi.aws.route53.inputs.RecordsExclusiveResourceRecordSetArgs;
import com.pulumi.aws.route53.inputs.RecordsExclusiveResourceRecordSetResourceRecordArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Zone("example", ZoneArgs.builder()
.name("example.com")
.forceDestroy(true)
.build());
var test = new RecordsExclusive("test", RecordsExclusiveArgs.builder()
.resourceRecordSets(RecordsExclusiveResourceRecordSetArgs.builder()
.resourceRecords(
RecordsExclusiveResourceRecordSetResourceRecordArgs.builder()
.value("127.0.0.1")
.build(),
RecordsExclusiveResourceRecordSetResourceRecordArgs.builder()
.value("127.0.0.27")
.build())
.name("subdomain.example.com")
.type("A")
.ttl(30)
.build())
.zoneId(testAwsRoute53Zone.zoneId())
.build());
}
}
resources:
example:
type: aws:route53:Zone
properties:
name: example.com
forceDestroy: true
test:
type: aws:route53:RecordsExclusive
properties:
resourceRecordSets:
- resourceRecords:
- value: 127.0.0.1
- value: 127.0.0.27
name: subdomain.example.com
type: A
ttl: '30'
zoneId: ${testAwsRoute53Zone.zoneId}
Disallow Record Sets
To automatically remove any configured record sets, omit a resourceRecordSet block.
> This will not prevent record sets from being defined in a hosted zone via Terraform (or any other interface). This resource enables bringing record set definitions into a configured state, however, this reconciliation happens only when apply is proactively run.
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const test = new aws.route53.RecordsExclusive("test", {zoneId: testAwsRoute53Zone.zoneId});
import pulumi
import pulumi_aws as aws
test = aws.route53.RecordsExclusive("test", zone_id=test_aws_route53_zone["zoneId"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var test = new Aws.Route53.RecordsExclusive("test", new()
{
ZoneId = testAwsRoute53Zone.ZoneId,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/route53"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := route53.NewRecordsExclusive(ctx, "test", &route53.RecordsExclusiveArgs{
ZoneId: pulumi.Any(testAwsRoute53Zone.ZoneId),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_route53_recordsexclusive" "test" {
zone_id = testAwsRoute53Zone.zoneId
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.route53.RecordsExclusive;
import com.pulumi.aws.route53.RecordsExclusiveArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var test = new RecordsExclusive("test", RecordsExclusiveArgs.builder()
.zoneId(testAwsRoute53Zone.zoneId())
.build());
}
}
resources:
test:
type: aws:route53:RecordsExclusive
properties:
zoneId: ${testAwsRoute53Zone.zoneId}
Import
Using pulumi import, import Route 53 Records Exclusive using the zoneId. For example:
$ pulumi import aws:route53/recordsExclusive:RecordsExclusive example ABCD1234
Constructors
- RecordsExclusive(String name, {RecordsExclusiveArgs? args, CustomResourceOptions? options})
-
Creates a new RecordsExclusive.
nameThe Pulumi resource name.argsArguments used to configure this RecordsExclusive. The set of arguments for RecordsExclusive.optionsResource options controlling this resource's behavior. - RecordsExclusive.reference(String urn)
- Creates a typed reference to an existing RecordsExclusive resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
resourceRecordSets
↔ Output<
List< RecordsExclusiveResourceRecordSet> ?> -
A list of all resource record sets associated with the hosted zone.
See
resourceRecordSetbelow.latefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
timeouts
↔ Output<
RecordsExclusiveTimeouts?> -
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
zoneId
↔ Output<
String> -
ID of the hosted zone containing the resource record sets.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {RecordsExclusiveState? state, CustomResourceOptions? options}) → RecordsExclusive -
Gets an existing RecordsExclusive resource's state with the given
nameandid.