Class CfnEndpointAuthorization
A CloudFormation AWS::Redshift::EndpointAuthorization
.
Inherited Members
Namespace: Amazon.CDK.AWS.Redshift
Assembly: Amazon.CDK.AWS.Redshift.dll
Syntax (csharp)
public class CfnEndpointAuthorization : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnEndpointAuthorization
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
Describes an endpoint authorization for authorizing Redshift-managed VPC endpoint access to a cluster across AWS accounts .
CloudformationResource: AWS::Redshift::EndpointAuthorization
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Redshift;
var cfnEndpointAuthorization = new CfnEndpointAuthorization(this, "MyCfnEndpointAuthorization", new CfnEndpointAuthorizationProps {
Account = "account",
ClusterIdentifier = "clusterIdentifier",
// the properties below are optional
Force = false,
VpcIds = new [] { "vpcIds" }
});
Synopsis
Constructors
CfnEndpointAuthorization(Construct, String, ICfnEndpointAuthorizationProps) | Create a new |
CfnEndpointAuthorization(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnEndpointAuthorization(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
Account | The AWS account ID of either the cluster owner (grantor) or grantee. |
AttrAllowedAllVpCs | Indicates whether all VPCs in the grantee account are allowed access to the cluster. |
AttrAllowedVpCs | The VPCs allowed access to the cluster. |
AttrAuthorizeTime | The time (UTC) when the authorization was created. |
AttrClusterStatus | The status of the cluster. |
AttrEndpointCount | The number of Redshift-managed VPC endpoints created for the authorization. |
AttrGrantee | The AWS account ID of the grantee of the cluster. |
AttrGrantor | The AWS account ID of the cluster owner. |
AttrStatus | The status of the authorization action. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
ClusterIdentifier | The cluster identifier. |
Force | Indicates whether to force the revoke action. |
VpcIds | The virtual private cloud (VPC) identifiers to grant access to. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnEndpointAuthorization(Construct, String, ICfnEndpointAuthorizationProps)
Create a new AWS::Redshift::EndpointAuthorization
.
public CfnEndpointAuthorization(Construct scope, string id, ICfnEndpointAuthorizationProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnEndpointAuthorizationProps
- resource properties.
CfnEndpointAuthorization(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnEndpointAuthorization(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnEndpointAuthorization(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnEndpointAuthorization(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
Account
The AWS account ID of either the cluster owner (grantor) or grantee.
public virtual string Account { get; set; }
Property Value
System.String
Remarks
If Grantee
parameter is true, then the Account
value is of the grantor.
AttrAllowedAllVpCs
Indicates whether all VPCs in the grantee account are allowed access to the cluster.
public virtual IResolvable AttrAllowedAllVpCs { get; }
Property Value
Remarks
CloudformationAttribute: AllowedAllVPCs
AttrAllowedVpCs
The VPCs allowed access to the cluster.
public virtual string[] AttrAllowedVpCs { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: AllowedVPCs
AttrAuthorizeTime
The time (UTC) when the authorization was created.
public virtual string AttrAuthorizeTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: AuthorizeTime
AttrClusterStatus
The status of the cluster.
public virtual string AttrClusterStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ClusterStatus
AttrEndpointCount
The number of Redshift-managed VPC endpoints created for the authorization.
public virtual double AttrEndpointCount { get; }
Property Value
System.Double
Remarks
CloudformationAttribute: EndpointCount
AttrGrantee
The AWS account ID of the grantee of the cluster.
public virtual string AttrGrantee { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Grantee
AttrGrantor
The AWS account ID of the cluster owner.
public virtual string AttrGrantor { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Grantor
AttrStatus
The status of the authorization action.
public virtual string AttrStatus { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Status
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
ClusterIdentifier
The cluster identifier.
public virtual string ClusterIdentifier { get; set; }
Property Value
System.String
Remarks
Force
Indicates whether to force the revoke action.
public virtual object Force { get; set; }
Property Value
System.Object
Remarks
If true, the Redshift-managed VPC endpoints associated with the endpoint authorization are also deleted.
VpcIds
The virtual private cloud (VPC) identifiers to grant access to.
public virtual string[] VpcIds { get; set; }
Property Value
System.String[]
Remarks
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
- tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>