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

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

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

aws-native.redshift.getEndpointAuthorization

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.108.3 published on Wednesday, Jun 12, 2024 by Pulumi

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

    Using getEndpointAuthorization

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getEndpointAuthorization(args: GetEndpointAuthorizationArgs, opts?: InvokeOptions): Promise<GetEndpointAuthorizationResult>
    function getEndpointAuthorizationOutput(args: GetEndpointAuthorizationOutputArgs, opts?: InvokeOptions): Output<GetEndpointAuthorizationResult>
    def get_endpoint_authorization(account: Optional[str] = None,
                                   cluster_identifier: Optional[str] = None,
                                   opts: Optional[InvokeOptions] = None) -> GetEndpointAuthorizationResult
    def get_endpoint_authorization_output(account: Optional[pulumi.Input[str]] = None,
                                   cluster_identifier: Optional[pulumi.Input[str]] = None,
                                   opts: Optional[InvokeOptions] = None) -> Output[GetEndpointAuthorizationResult]
    func LookupEndpointAuthorization(ctx *Context, args *LookupEndpointAuthorizationArgs, opts ...InvokeOption) (*LookupEndpointAuthorizationResult, error)
    func LookupEndpointAuthorizationOutput(ctx *Context, args *LookupEndpointAuthorizationOutputArgs, opts ...InvokeOption) LookupEndpointAuthorizationResultOutput

    > Note: This function is named LookupEndpointAuthorization in the Go SDK.

    public static class GetEndpointAuthorization 
    {
        public static Task<GetEndpointAuthorizationResult> InvokeAsync(GetEndpointAuthorizationArgs args, InvokeOptions? opts = null)
        public static Output<GetEndpointAuthorizationResult> Invoke(GetEndpointAuthorizationInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEndpointAuthorizationResult> getEndpointAuthorization(GetEndpointAuthorizationArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws-native:redshift:getEndpointAuthorization
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Account string
    The target AWS account ID to grant or revoke access for.
    ClusterIdentifier string
    The cluster identifier.
    Account string
    The target AWS account ID to grant or revoke access for.
    ClusterIdentifier string
    The cluster identifier.
    account String
    The target AWS account ID to grant or revoke access for.
    clusterIdentifier String
    The cluster identifier.
    account string
    The target AWS account ID to grant or revoke access for.
    clusterIdentifier string
    The cluster identifier.
    account str
    The target AWS account ID to grant or revoke access for.
    cluster_identifier str
    The cluster identifier.
    account String
    The target AWS account ID to grant or revoke access for.
    clusterIdentifier String
    The cluster identifier.

    getEndpointAuthorization Result

    The following output properties are available:

    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.
    Status string
    The status of the authorization action.
    VpcIds List<string>
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    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.
    Status string
    The status of the authorization action.
    VpcIds []string
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    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.
    status String
    The status of the authorization action.
    vpcIds List<String>
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    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.
    status string
    The status of the authorization action.
    vpcIds string[]
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    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.
    status str
    The status of the authorization action.
    vpc_ids Sequence[str]
    The virtual private cloud (VPC) identifiers to grant or revoke access to.
    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.
    status String
    The status of the authorization action.
    vpcIds List<String>
    The virtual private cloud (VPC) identifiers to grant or revoke access to.

    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.108.3 published on Wednesday, Jun 12, 2024 by Pulumi