Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. redshift
  5. EndpointAuthorization

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.redshift.EndpointAuthorization

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts.

    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: 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-native: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.

    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

    The EndpointAuthorization resource accepts the following input properties:

    Account string
    The target AWS account ID to grant or revoke access for.
    ClusterIdentifier string
    The cluster identifier.
    Force bool
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
    VpcIds List<string>
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    Account string
    The target AWS account ID to grant or revoke access for.
    ClusterIdentifier string
    The cluster identifier.
    Force bool
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
    VpcIds []string
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    account String
    The target AWS account ID to grant or revoke access for.
    clusterIdentifier String
    The cluster identifier.
    force Boolean
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
    vpcIds List<String>
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    account string
    The target AWS account ID to grant or revoke access for.
    clusterIdentifier string
    The cluster identifier.
    force boolean
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
    vpcIds string[]
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    account str
    The target AWS account ID to grant or revoke access for.
    cluster_identifier str
    The cluster identifier.
    force bool
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
    vpc_ids Sequence[str]
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    account String
    The target AWS account ID to grant or revoke access for.
    clusterIdentifier String
    The cluster identifier.
    force Boolean
    Indicates whether to force the revoke action. If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
    vpcIds List<String>
    The virtual private cloud (VPC) identifiers to grant or revoke access to.

    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.
    AllowedVpcs List<string>
    The VPCs allowed access to the cluster.
    AuthorizeTime string
    The time (UTC) when the authorization was created.
    ClusterStatus string
    The status of the cluster.
    EndpointCount int
    The number of Redshift-managed VPC endpoints created for the authorization.
    Grantee string
    The AWS account ID of the grantee of the cluster.
    Grantor string
    The AWS account ID of the cluster owner.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the authorization action.
    AllowedAllVpcs bool
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    AllowedVpcs []string
    The VPCs allowed access to the cluster.
    AuthorizeTime string
    The time (UTC) when the authorization was created.
    ClusterStatus string
    The status of the cluster.
    EndpointCount int
    The number of Redshift-managed VPC endpoints created for the authorization.
    Grantee string
    The AWS account ID of the grantee of the cluster.
    Grantor string
    The AWS account ID of the cluster owner.
    Id string
    The provider-assigned unique ID for this managed resource.
    Status string
    The status of the authorization action.
    allowedAllVpcs Boolean
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    allowedVpcs List<String>
    The VPCs allowed access to the cluster.
    authorizeTime String
    The time (UTC) when the authorization was created.
    clusterStatus String
    The status of the cluster.
    endpointCount Integer
    The number of Redshift-managed VPC endpoints created for the authorization.
    grantee String
    The AWS account ID of the grantee of the cluster.
    grantor String
    The AWS account ID of the cluster owner.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the authorization action.
    allowedAllVpcs boolean
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    allowedVpcs string[]
    The VPCs allowed access to the cluster.
    authorizeTime string
    The time (UTC) when the authorization was created.
    clusterStatus string
    The status of the cluster.
    endpointCount number
    The number of Redshift-managed VPC endpoints created for the authorization.
    grantee string
    The AWS account ID of the grantee of the cluster.
    grantor string
    The AWS account ID of the cluster owner.
    id string
    The provider-assigned unique ID for this managed resource.
    status string
    The status of the authorization action.
    allowed_all_vpcs bool
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    allowed_vpcs Sequence[str]
    The VPCs allowed access to the cluster.
    authorize_time str
    The time (UTC) when the authorization was created.
    cluster_status str
    The status of the cluster.
    endpoint_count int
    The number of Redshift-managed VPC endpoints created for the authorization.
    grantee str
    The AWS account ID of the grantee of the cluster.
    grantor str
    The AWS account ID of the cluster owner.
    id str
    The provider-assigned unique ID for this managed resource.
    status str
    The status of the authorization action.
    allowedAllVpcs Boolean
    Indicates whether all VPCs in the grantee account are allowed access to the cluster.
    allowedVpcs List<String>
    The VPCs allowed access to the cluster.
    authorizeTime String
    The time (UTC) when the authorization was created.
    clusterStatus String
    The status of the cluster.
    endpointCount Number
    The number of Redshift-managed VPC endpoints created for the authorization.
    grantee String
    The AWS account ID of the grantee of the cluster.
    grantor String
    The AWS account ID of the cluster owner.
    id String
    The provider-assigned unique ID for this managed resource.
    status String
    The status of the authorization action.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native