DomainNameAccessAssociation class
Creates a domain name access association resource between an access association source and a private custom domain name.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.apigateway.DomainNameAccessAssociation("example", {
accessAssociationSource: exampleAwsVpcEndpoint.id,
accessAssociationSourceType: "VPCE",
domainNameArn: exampleAwsApiGatewayDomainName.arn,
});
import pulumi
import pulumi_aws as aws
example = aws.apigateway.DomainNameAccessAssociation("example",
access_association_source=example_aws_vpc_endpoint["id"],
access_association_source_type="VPCE",
domain_name_arn=example_aws_api_gateway_domain_name["arn"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.ApiGateway.DomainNameAccessAssociation("example", new()
{
AccessAssociationSource = exampleAwsVpcEndpoint.Id,
AccessAssociationSourceType = "VPCE",
DomainNameArn = exampleAwsApiGatewayDomainName.Arn,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/apigateway"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := apigateway.NewDomainNameAccessAssociation(ctx, "example", &apigateway.DomainNameAccessAssociationArgs{
AccessAssociationSource: pulumi.Any(exampleAwsVpcEndpoint.Id),
AccessAssociationSourceType: pulumi.String("VPCE"),
DomainNameArn: pulumi.Any(exampleAwsApiGatewayDomainName.Arn),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_apigateway_domainnameaccessassociation" "example" {
access_association_source = exampleAwsVpcEndpoint.id
access_association_source_type = "VPCE"
domain_name_arn = exampleAwsApiGatewayDomainName.arn
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.apigateway.DomainNameAccessAssociation;
import com.pulumi.aws.apigateway.DomainNameAccessAssociationArgs;
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 DomainNameAccessAssociation("example", DomainNameAccessAssociationArgs.builder()
.accessAssociationSource(exampleAwsVpcEndpoint.id())
.accessAssociationSourceType("VPCE")
.domainNameArn(exampleAwsApiGatewayDomainName.arn())
.build());
}
}
resources:
example:
type: aws:apigateway:DomainNameAccessAssociation
properties:
accessAssociationSource: ${exampleAwsVpcEndpoint.id}
accessAssociationSourceType: VPCE
domainNameArn: ${exampleAwsApiGatewayDomainName.arn}
Import
Identity Schema
Required
arn(String) ARN of the API Gateway domain name access association.
Using pulumi import, import API Gateway domain name acces associations as using their arn. For example:
$ pulumi import aws:apigateway/domainNameAccessAssociation:DomainNameAccessAssociation example arn:aws:apigateway:us-west-2:123456789012:/domainnameaccessassociations/domainname/12qmzgp2.9m7ilski.test+hykg7a12e7/vpcesource/vpce-05de3f8f82740a748
Constructors
- DomainNameAccessAssociation(String name, {DomainNameAccessAssociationArgs? args, CustomResourceOptions? options})
-
Creates a new DomainNameAccessAssociation.
nameThe Pulumi resource name.argsArguments used to configure this DomainNameAccessAssociation. The set of arguments for DomainNameAccessAssociation.optionsResource options controlling this resource's behavior. - DomainNameAccessAssociation.reference(String urn)
- Creates a typed reference to an existing DomainNameAccessAssociation resource.
Properties
-
accessAssociationSource
↔ Output<
String> -
Identifier of the domain name access association source. For a
VPCE, the value is the VPC endpoint ID.latefinal -
accessAssociationSourceType
↔ Output<
String> -
Type of the domain name access association source. Valid values are
VPCE.latefinal -
arn
↔ Output<
String> -
ARN of the domain name access association.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
domainNameArn
↔ Output<
String> -
ARN of the domain name.
latefinal
- 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
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
Key-value map of resource tags. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
Map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
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, {DomainNameAccessAssociationState? state, CustomResourceOptions? options}) → DomainNameAccessAssociation -
Gets an existing DomainNameAccessAssociation resource's state with the given
nameandid.