software.amazon.awscdk.services.redshift

Class CfnEndpointAuthorization

java.lang.Object

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

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.846Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

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

Methods inherited from class software.amazon.awscdk.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnEndpointAuthorization(Construct scope,
                                java.lang.String id,
                                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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAllowedAllVpCs

public IResolvable getAttrAllowedAllVpCs()

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

getAttrAllowedVpCs

public java.util.List<java.lang.String> getAttrAllowedVpCs()

The VPCs allowed access to the cluster.

getAttrAuthorizeTime

public java.lang.String getAttrAuthorizeTime()

The time (UTC) when the authorization was created.

getAttrClusterStatus

public java.lang.String getAttrClusterStatus()

The status of the cluster.

getAttrEndpointCount

public java.lang.Number getAttrEndpointCount()

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

getAttrGrantee

public java.lang.String getAttrGrantee()

The AWS account ID of the grantee of the cluster.

getAttrGrantor

public java.lang.String getAttrGrantor()

The AWS account ID of the cluster owner.

getAttrStatus

public java.lang.String getAttrStatus()

The status of the authorization action.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getAccount

public java.lang.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

public void setAccount(java.lang.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

public java.lang.String getClusterIdentifier()

The cluster identifier.

setClusterIdentifier

public void setClusterIdentifier(java.lang.String value)

The cluster identifier.

getForce

public java.lang.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

public void setForce(java.lang.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

public void setForce(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

public java.util.List<java.lang.String> getVpcIds()

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

setVpcIds

public void setVpcIds(java.util.List<java.lang.String> value)

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