Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. redshift
  5. EndpointAuthorization
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

aws.redshift.EndpointAuthorization

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
pulumi/pulumi-aws

    Creates a new Amazon Redshift endpoint authorization.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.redshift.EndpointAuthorization("example", {
    account: "01234567910",
    clusterIdentifier: exampleAwsRedshiftCluster.clusterIdentifier,
});

    import pulumi
import pulumi_aws as aws

example = aws.redshift.EndpointAuthorization("example",
    account="01234567910",
    cluster_identifier=example_aws_redshift_cluster["clusterIdentifier"])

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/redshift"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := redshift.NewEndpointAuthorization(ctx, "example", &redshift.EndpointAuthorizationArgs{
			Account:           pulumi.String("01234567910"),
			ClusterIdentifier: pulumi.Any(exampleAwsRedshiftCluster.ClusterIdentifier),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.RedShift.EndpointAuthorization("example", new()
    {
        Account = "01234567910",
        ClusterIdentifier = exampleAwsRedshiftCluster.ClusterIdentifier,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.redshift.EndpointAuthorization;
import com.pulumi.aws.redshift.EndpointAuthorizationArgs;
import java.util.List;
import java.util.ArrayList;
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 EndpointAuthorization("example", EndpointAuthorizationArgs.builder()
            .account("01234567910")
            .clusterIdentifier(exampleAwsRedshiftCluster.clusterIdentifier())
            .build());

    }
}

    resources:
  example:
    type: aws:redshift:EndpointAuthorization
    properties:
      account: '01234567910'
      clusterIdentifier: ${exampleAwsRedshiftCluster.clusterIdentifier}

    Create EndpointAuthorization Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new EndpointAuthorization(name: string, args: EndpointAuthorizationArgs, opts?: CustomResourceOptions);
    @overload
def EndpointAuthorization(resource_name: str,
                          args: EndpointAuthorizationArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def EndpointAuthorization(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          account: Optional[str] = None,
                          cluster_identifier: Optional[str] = None,
                          force_delete: Optional[bool] = None,
                          vpc_ids: Optional[Sequence[str]] = None)
    func NewEndpointAuthorization(ctx *Context, name string, args EndpointAuthorizationArgs, opts ...ResourceOption) (*EndpointAuthorization, error)
    public EndpointAuthorization(string name, EndpointAuthorizationArgs args, CustomResourceOptions? opts = null)
    public EndpointAuthorization(String name, EndpointAuthorizationArgs args)
public EndpointAuthorization(String name, EndpointAuthorizationArgs args, CustomResourceOptions options)

    type: aws:redshift:EndpointAuthorization
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args EndpointAuthorizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args EndpointAuthorizationArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args EndpointAuthorizationArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EndpointAuthorizationArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EndpointAuthorizationArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var endpointAuthorizationResource = new Aws.RedShift.EndpointAuthorization("endpointAuthorizationResource", new()
{
    Account = "string",
    ClusterIdentifier = "string",
    ForceDelete = false,
    VpcIds = new[]
    {
        "string",
    },
});

    example, err := redshift.NewEndpointAuthorization(ctx, "endpointAuthorizationResource", &redshift.EndpointAuthorizationArgs{
	Account:           pulumi.String("string"),
	ClusterIdentifier: pulumi.String("string"),
	ForceDelete:       pulumi.Bool(false),
	VpcIds: pulumi.StringArray{
		pulumi.String("string"),
	},
})

    var endpointAuthorizationResource = new EndpointAuthorization("endpointAuthorizationResource", EndpointAuthorizationArgs.builder()
    .account("string")
    .clusterIdentifier("string")
    .forceDelete(false)
    .vpcIds("string")
    .build());

    endpoint_authorization_resource = aws.redshift.EndpointAuthorization("endpointAuthorizationResource",
    account="string",
    cluster_identifier="string",
    force_delete=False,
    vpc_ids=["string"])

    const endpointAuthorizationResource = new aws.redshift.EndpointAuthorization("endpointAuthorizationResource", {
    account: "string",
    clusterIdentifier: "string",
    forceDelete: false,
    vpcIds: ["string"],
});

    type: aws:redshift:EndpointAuthorization
properties:
    account: string
    clusterIdentifier: string
    forceDelete: false
    vpcIds:
        - string

    EndpointAuthorization Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The EndpointAuthorization resource accepts the following input properties:

    Account string
    The Amazon Web Services account ID to grant access to.
    ClusterIdentifier string
    The cluster identifier of the cluster to grant access to.
    ForceDelete bool
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    VpcIds List<string>
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    Account string
    The Amazon Web Services account ID to grant access to.
    ClusterIdentifier string
    The cluster identifier of the cluster to grant access to.
    ForceDelete bool
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    VpcIds []string
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    account String
    The Amazon Web Services account ID to grant access to.
    clusterIdentifier String
    The cluster identifier of the cluster to grant access to.
    forceDelete Boolean
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    vpcIds List<String>
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    account string
    The Amazon Web Services account ID to grant access to.
    clusterIdentifier string
    The cluster identifier of the cluster to grant access to.
    forceDelete boolean
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    vpcIds string[]
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    account str
    The Amazon Web Services account ID to grant access to.
    cluster_identifier str
    The cluster identifier of the cluster to grant access to.
    force_delete bool
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    vpc_ids Sequence[str]
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    account String
    The Amazon Web Services account ID to grant access to.
    clusterIdentifier String
    The cluster identifier of the cluster to grant access to.
    forceDelete Boolean
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    vpcIds List<String>
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the EndpointAuthorization resource produces the following output properties:

    AllowedAllVpcs bool
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    EndpointCount int
    The number of Redshift-managed VPC endpoints created for the authorization.
    Grantee string
    The Amazon Web Services account ID of the grantee of the cluster.
    Grantor string
    The Amazon Web Services account ID of the cluster owner.
    Id string
    The provider-assigned unique ID for this managed resource.
    AllowedAllVpcs bool
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    EndpointCount int
    The number of Redshift-managed VPC endpoints created for the authorization.
    Grantee string
    The Amazon Web Services account ID of the grantee of the cluster.
    Grantor string
    The Amazon Web Services account ID of the cluster owner.
    Id string
    The provider-assigned unique ID for this managed resource.
    allowedAllVpcs Boolean
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    endpointCount Integer
    The number of Redshift-managed VPC endpoints created for the authorization.
    grantee String
    The Amazon Web Services account ID of the grantee of the cluster.
    grantor String
    The Amazon Web Services account ID of the cluster owner.
    id String
    The provider-assigned unique ID for this managed resource.
    allowedAllVpcs boolean
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    endpointCount number
    The number of Redshift-managed VPC endpoints created for the authorization.
    grantee string
    The Amazon Web Services account ID of the grantee of the cluster.
    grantor string
    The Amazon Web Services account ID of the cluster owner.
    id string
    The provider-assigned unique ID for this managed resource.
    allowed_all_vpcs bool
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    endpoint_count int
    The number of Redshift-managed VPC endpoints created for the authorization.
    grantee str
    The Amazon Web Services account ID of the grantee of the cluster.
    grantor str
    The Amazon Web Services account ID of the cluster owner.
    id str
    The provider-assigned unique ID for this managed resource.
    allowedAllVpcs Boolean
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    endpointCount Number
    The number of Redshift-managed VPC endpoints created for the authorization.
    grantee String
    The Amazon Web Services account ID of the grantee of the cluster.
    grantor String
    The Amazon Web Services account ID of the cluster owner.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing EndpointAuthorization Resource

    Get an existing EndpointAuthorization resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: EndpointAuthorizationState, opts?: CustomResourceOptions): EndpointAuthorization
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        account: Optional[str] = None,
        allowed_all_vpcs: Optional[bool] = None,
        cluster_identifier: Optional[str] = None,
        endpoint_count: Optional[int] = None,
        force_delete: Optional[bool] = None,
        grantee: Optional[str] = None,
        grantor: Optional[str] = None,
        vpc_ids: Optional[Sequence[str]] = None) -> EndpointAuthorization
    func GetEndpointAuthorization(ctx *Context, name string, id IDInput, state *EndpointAuthorizationState, opts ...ResourceOption) (*EndpointAuthorization, error)
    public static EndpointAuthorization Get(string name, Input<string> id, EndpointAuthorizationState? state, CustomResourceOptions? opts = null)
    public static EndpointAuthorization get(String name, Output<String> id, EndpointAuthorizationState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Account string
    The Amazon Web Services account ID to grant access to.
    AllowedAllVpcs bool
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    ClusterIdentifier string
    The cluster identifier of the cluster to grant access to.
    EndpointCount int
    The number of Redshift-managed VPC endpoints created for the authorization.
    ForceDelete bool
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    Grantee string
    The Amazon Web Services account ID of the grantee of the cluster.
    Grantor string
    The Amazon Web Services account ID of the cluster owner.
    VpcIds List<string>
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    Account string
    The Amazon Web Services account ID to grant access to.
    AllowedAllVpcs bool
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    ClusterIdentifier string
    The cluster identifier of the cluster to grant access to.
    EndpointCount int
    The number of Redshift-managed VPC endpoints created for the authorization.
    ForceDelete bool
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    Grantee string
    The Amazon Web Services account ID of the grantee of the cluster.
    Grantor string
    The Amazon Web Services account ID of the cluster owner.
    VpcIds []string
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    account String
    The Amazon Web Services account ID to grant access to.
    allowedAllVpcs Boolean
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    clusterIdentifier String
    The cluster identifier of the cluster to grant access to.
    endpointCount Integer
    The number of Redshift-managed VPC endpoints created for the authorization.
    forceDelete Boolean
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    grantee String
    The Amazon Web Services account ID of the grantee of the cluster.
    grantor String
    The Amazon Web Services account ID of the cluster owner.
    vpcIds List<String>
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    account string
    The Amazon Web Services account ID to grant access to.
    allowedAllVpcs boolean
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    clusterIdentifier string
    The cluster identifier of the cluster to grant access to.
    endpointCount number
    The number of Redshift-managed VPC endpoints created for the authorization.
    forceDelete boolean
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    grantee string
    The Amazon Web Services account ID of the grantee of the cluster.
    grantor string
    The Amazon Web Services account ID of the cluster owner.
    vpcIds string[]
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    account str
    The Amazon Web Services account ID to grant access to.
    allowed_all_vpcs bool
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    cluster_identifier str
    The cluster identifier of the cluster to grant access to.
    endpoint_count int
    The number of Redshift-managed VPC endpoints created for the authorization.
    force_delete bool
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    grantee str
    The Amazon Web Services account ID of the grantee of the cluster.
    grantor str
    The Amazon Web Services account ID of the cluster owner.
    vpc_ids Sequence[str]
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.
    account String
    The Amazon Web Services account ID to grant access to.
    allowedAllVpcs Boolean
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    clusterIdentifier String
    The cluster identifier of the cluster to grant access to.
    endpointCount Number
    The number of Redshift-managed VPC endpoints created for the authorization.
    forceDelete Boolean
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted. Default value is false.
    grantee String
    The Amazon Web Services account ID of the grantee of the cluster.
    grantor String
    The Amazon Web Services account ID of the cluster owner.
    vpcIds List<String>
    The virtual private cloud (VPC) identifiers to grant access to. If none are specified all VPCs in shared account are allowed.

    Import

    Using pulumi import, import Redshift endpoint authorization using the id. For example:

    $ pulumi import aws:redshift/endpointAuthorization:EndpointAuthorization example 01234567910:cluster-example-id

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi
    pulumi/pulumi-aws