EndpointAccess class
Creates a new Amazon Redshift endpoint access.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.redshift.EndpointAccess("example", {
endpointName: "example",
subnetGroupName: exampleAwsRedshiftSubnetGroup.id,
clusterIdentifier: exampleAwsRedshiftCluster.clusterIdentifier,
});
import pulumi
import pulumi_aws as aws
example = aws.redshift.EndpointAccess("example",
endpoint_name="example",
subnet_group_name=example_aws_redshift_subnet_group["id"],
cluster_identifier=example_aws_redshift_cluster["clusterIdentifier"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.RedShift.EndpointAccess("example", new()
{
EndpointName = "example",
SubnetGroupName = exampleAwsRedshiftSubnetGroup.Id,
ClusterIdentifier = exampleAwsRedshiftCluster.ClusterIdentifier,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/redshift"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := redshift.NewEndpointAccess(ctx, "example", &redshift.EndpointAccessArgs{
EndpointName: pulumi.String("example"),
SubnetGroupName: pulumi.Any(exampleAwsRedshiftSubnetGroup.Id),
ClusterIdentifier: pulumi.Any(exampleAwsRedshiftCluster.ClusterIdentifier),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_redshift_endpointaccess" "example" {
endpoint_name = "example"
subnet_group_name = exampleAwsRedshiftSubnetGroup.id
cluster_identifier = exampleAwsRedshiftCluster.clusterIdentifier
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.EndpointAccess;
import com.pulumi.aws.redshift.EndpointAccessArgs;
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 EndpointAccess("example", EndpointAccessArgs.builder()
.endpointName("example")
.subnetGroupName(exampleAwsRedshiftSubnetGroup.id())
.clusterIdentifier(exampleAwsRedshiftCluster.clusterIdentifier())
.build());
}
}
resources:
example:
type: aws:redshift:EndpointAccess
properties:
endpointName: example
subnetGroupName: ${exampleAwsRedshiftSubnetGroup.id}
clusterIdentifier: ${exampleAwsRedshiftCluster.clusterIdentifier}
Import
Using pulumi import, import Redshift endpoint access using the name. For example:
$ pulumi import aws:redshift/endpointAccess:EndpointAccess example example
Constructors
- EndpointAccess(String name, {EndpointAccessArgs? args, CustomResourceOptions? options})
-
Creates a new EndpointAccess.
nameThe Pulumi resource name.argsArguments used to configure this EndpointAccess. The set of arguments for EndpointAccess.optionsResource options controlling this resource's behavior. - EndpointAccess.reference(String urn)
- Creates a typed reference to an existing EndpointAccess resource.
Properties
-
address
↔ Output<
String> -
The DNS address of the endpoint.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
clusterIdentifier
↔ Output<
String> -
The cluster identifier of the cluster to access.
latefinal
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
endpointName
↔ Output<
String> -
The Redshift-managed VPC endpoint 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
-
port
↔ Output<
int> -
The port number on which the cluster accepts incoming connections.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceOwner
↔ Output<
String> -
The Amazon Web Services account ID of the owner of the cluster. This is only required if the cluster is in another Amazon Web Services account.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
subnetGroupName
↔ Output<
String> -
The subnet group from which Amazon Redshift chooses the subnet to deploy the endpoint.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcEndpoints
↔ Output<
List< EndpointAccessVpcEndpoint> > -
The connection endpoint for connecting to an Amazon Redshift cluster through the proxy. See details below.
latefinal
-
vpcSecurityGroupIds
↔ Output<
List< String> > -
The security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
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, {EndpointAccessState? state, CustomResourceOptions? options}) → EndpointAccess -
Gets an existing EndpointAccess resource's state with the given
nameandid.