Package software.amazon.awscdk.services.redshift

Class CfnEndpointAuthorization

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.redshift.CfnEndpointAuthorization
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.798Z") @Stability(Stable) public class CfnEndpointAuthorization extends CfnResource implements IInspectable
A CloudFormation AWS::Redshift::EndpointAuthorization.

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

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.redshift.*;
 CfnEndpointAuthorization cfnEndpointAuthorization = CfnEndpointAuthorization.Builder.create(this, "MyCfnEndpointAuthorization")
         .account("account")
         .clusterIdentifier("clusterIdentifier")
         // the properties below are optional
         .force(false)
         .vpcIds(List.of("vpcIds"))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnEndpointAuthorization

      protected CfnEndpointAuthorization(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnEndpointAuthorization

      protected CfnEndpointAuthorization(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnEndpointAuthorization

      @Stability(Stable) public CfnEndpointAuthorization(@NotNull Construct scope, @NotNull String id, @NotNull CfnEndpointAuthorizationProps props)
      Create a new AWS::Redshift::EndpointAuthorization.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAllowedAllVpCs

      @Stability(Stable) @NotNull public IResolvable getAttrAllowedAllVpCs()
      Indicates whether all VPCs in the grantee account are allowed access to the cluster.

    • getAttrAllowedVpCs

      @Stability(Stable) @NotNull public List<String> getAttrAllowedVpCs()
      The VPCs allowed access to the cluster.

    • getAttrAuthorizeTime

      @Stability(Stable) @NotNull public String getAttrAuthorizeTime()
      The time (UTC) when the authorization was created.

    • getAttrClusterStatus

      @Stability(Stable) @NotNull public String getAttrClusterStatus()
      The status of the cluster.

    • getAttrEndpointCount

      @Stability(Stable) @NotNull public Number getAttrEndpointCount()
      The number of Redshift-managed VPC endpoints created for the authorization.

    • getAttrGrantee

      @Stability(Stable) @NotNull public String getAttrGrantee()
      The AWS account ID of the grantee of the cluster.

    • getAttrGrantor

      @Stability(Stable) @NotNull public String getAttrGrantor()
      The AWS account ID of the cluster owner.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status of the authorization action.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getAccount

      @Stability(Stable) @NotNull public String getAccount()
      The AWS account ID of either the cluster owner (grantor) or grantee.

      If Grantee parameter is true, then the Account value is of the grantor.

    • setAccount

      @Stability(Stable) public void setAccount(@NotNull String value)
      The AWS account ID of either the cluster owner (grantor) or grantee.

      If Grantee parameter is true, then the Account value is of the grantor.

    • getClusterIdentifier

      @Stability(Stable) @NotNull public String getClusterIdentifier()
      The cluster identifier.

    • setClusterIdentifier

      @Stability(Stable) public void setClusterIdentifier(@NotNull String value)
      The cluster identifier.

    • getForce

      @Stability(Stable) @Nullable public Object getForce()
      Indicates whether to force the revoke action.

      If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.

    • setForce

      @Stability(Stable) public void setForce(@Nullable Boolean value)
      Indicates whether to force the revoke action.

      If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.

    • setForce

      @Stability(Stable) public void setForce(@Nullable IResolvable value)
      Indicates whether to force the revoke action.

      If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.

    • getVpcIds

      @Stability(Stable) @Nullable public List<String> getVpcIds()
      The virtual private cloud (VPC) identifiers to grant access to.

    • setVpcIds

      @Stability(Stable) public void setVpcIds(@Nullable List<String> value)
      The virtual private cloud (VPC) identifiers to grant access to.