software.amazon.awscdk.services.redshift

Class CfnEndpointAuthorization

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.redshift.CfnEndpointAuthorization

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.539Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnEndpointAuthorization.Builder A fluent builder for CfnEndpointAuthorization.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnEndpointAuthorization(software.constructs.Construct scope, String id, CfnEndpointAuthorizationProps props) Create a new `AWS::Redshift::EndpointAuthorization`.
protected	CfnEndpointAuthorization(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnEndpointAuthorization(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAccount() The A AWS account ID of either the cluster owner (grantor) or grantee.
IResolvable	getAttrAllowedAllVpCs() Indicates whether all VPCs in the grantee account are allowed access to the cluster.
List<String>	getAttrAllowedVpCs() The VPCs allowed access to the cluster.
String	getAttrAuthorizeTime() The time (UTC) when the authorization was created.
String	getAttrClusterStatus() The status of the cluster.
Number	getAttrEndpointCount() The number of Redshift-managed VPC endpoints created for the authorization.
String	getAttrGrantee() The AWS account ID of the grantee of the cluster.
String	getAttrGrantor() The AWS account ID of the cluster owner.
String	getAttrStatus() The status of the authorization action.
protected Map<String,Object>	getCfnProperties()
String	getClusterIdentifier() The cluster identifier.
Object	getForce() Indicates whether to force the revoke action.
List<String>	getVpcIds() The virtual private cloud (VPC) identifiers to grant access to.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAccount(String value) The A AWS account ID of either the cluster owner (grantor) or grantee.
void	setClusterIdentifier(String value) The cluster identifier.
void	setForce(Boolean value) Indicates whether to force the revoke action.
void	setForce(IResolvable value) Indicates whether to force the revoke action.
void	setVpcIds(List<String> value) The virtual private cloud (VPC) identifiers to grant access to.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnEndpointAuthorization

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

CfnEndpointAuthorization

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

CfnEndpointAuthorization

@Stability(value=Stable)
public CfnEndpointAuthorization(@NotNull
                                                         software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public IResolvable getAttrAllowedAllVpCs()

Indicates whether all VPCs in the grantee account are allowed access to the cluster.

getAttrAllowedVpCs

@Stability(value=Stable)
 @NotNull
public List<String> getAttrAllowedVpCs()

The VPCs allowed access to the cluster.

getAttrAuthorizeTime

@Stability(value=Stable)
 @NotNull
public String getAttrAuthorizeTime()

The time (UTC) when the authorization was created.

getAttrClusterStatus

@Stability(value=Stable)
 @NotNull
public String getAttrClusterStatus()

The status of the cluster.

getAttrEndpointCount

@Stability(value=Stable)
 @NotNull
public Number getAttrEndpointCount()

The number of Redshift-managed VPC endpoints created for the authorization.

getAttrGrantee

@Stability(value=Stable)
 @NotNull
public String getAttrGrantee()

The AWS account ID of the grantee of the cluster.

getAttrGrantor

@Stability(value=Stable)
 @NotNull
public String getAttrGrantor()

The AWS account ID of the cluster owner.

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

The status of the authorization action.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAccount

@Stability(value=Stable)
 @NotNull
public String getAccount()

The A 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(value=Stable)
public void setAccount(@NotNull
                                                String value)

The A 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(value=Stable)
 @NotNull
public String getClusterIdentifier()

The cluster identifier.

setClusterIdentifier

@Stability(value=Stable)
public void setClusterIdentifier(@NotNull
                                                          String value)

The cluster identifier.

getForce

@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
public List<String> getVpcIds()

The virtual private cloud (VPC) identifiers to grant access to.

setVpcIds

@Stability(value=Stable)
public void setVpcIds(@Nullable
                                               List<String> value)

The virtual private cloud (VPC) identifiers to grant access to.