Documentation
¶
Index ¶
- func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCluster_FromIdentifier(scope constructs.Construct, id *string, identifier *string) interfacesawsdsql.IClusterRef
- func CfnCluster_IsCfnElement(x interface{}) *bool
- func CfnCluster_IsCfnResource(x interface{}) *bool
- func CfnCluster_IsConstruct(x interface{}) *bool
- func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
- type CfnCluster
- type CfnClusterProps
- type CfnCluster_EncryptionDetailsProperty
- type CfnCluster_MultiRegionPropertiesProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCluster_CFN_RESOURCE_TYPE_NAME ¶
func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnCluster_FromIdentifier ¶ added in v2.218.0
func CfnCluster_FromIdentifier(scope constructs.Construct, id *string, identifier *string) interfacesawsdsql.IClusterRef
Creates a new IClusterRef from a identifier.
func CfnCluster_IsCfnElement ¶
func CfnCluster_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCluster_IsCfnResource ¶
func CfnCluster_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCluster_IsConstruct ¶
func CfnCluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnCluster_Override ¶
func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
Create a new `AWS::DSQL::Cluster`.
Types ¶
type CfnCluster ¶
type CfnCluster interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsdsql.IClusterRef
awscdk.ITaggableV2
// The timestamp when the cluster was created, in ISO 8601 format.
AttrCreationTime() *string
// The encryption configuration details for the cluster.
AttrEncryptionDetails() awscdk.IResolvable
// The unique identifier assigned to the cluster upon creation.
AttrIdentifier() *string
// The version number of the cluster's resource based policy.
AttrPolicyVersion() *string
// The Amazon Resource Name (ARN) of the cluster.
//
// Used for IAM permissions and resource identification.
AttrResourceArn() *string
// The current status of the cluster. Possible values include: CREATING, ACTIVE, DELETING, FAILED.
//
// The cluster can have two additional status values when working with multi-Region clusters:
//
// `PENDING_SETUP` —Indicates the cluster is being configured
//
// `PENDING_DELETE` —Indicates the cluster is being deleted
//
// *Note:* These status values only appear for multi-Region cluster operations.
AttrStatus() *string
// The VPC Endpoint Service name for the cluster.
//
// This can be used to create a VPC endpoint to connect to the cluster from within a VPC.
AttrVpcEndpointServiceName() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// A reference to a Cluster resource.
ClusterRef() *interfacesawsdsql.ClusterReference
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// Whether deletion protection is enabled on this cluster.
DeletionProtectionEnabled() interface{}
SetDeletionProtectionEnabled(val interface{})
Env() *interfaces.ResourceEnvironment
// The KMS key that encrypts data on the cluster.
KmsEncryptionKey() *string
SetKmsEncryptionKey(val *string)
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.
MultiRegionProperties() interface{}
SetMultiRegionProperties(val interface{})
// The tree node.
Node() constructs.Node
// The IAM policy applied to the cluster resource.
PolicyDocument() *string
SetPolicyDocument(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A map of key and value pairs this cluster is tagged with.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
The `AWS::DSQL::Cluster` resource specifies an cluster. You can use this resource to create, modify, and manage clusters.
This resource supports both single-Region clusters and multi-Region clusters through the `MultiRegionProperties` parameter.
> Creating multi-Region clusters requires additional IAM permissions beyond those needed for single-Region clusters. > - The witness Region specified in `multiRegionProperties.witnessRegion` cannot be the same as the cluster's Region.
*Required permissions*
- **dsql:CreateCluster** - Required to create a cluster.
Resources: `arn:aws:dsql:region:account-id:cluster/*` - **dsql:TagResource** - Permission to add tags to a resource.
Resources: `arn:aws:dsql:region:account-id:cluster/*` - **dsql:PutMultiRegionProperties** - Permission to configure multi-Region properties for a cluster.
Resources: `arn:aws:dsql:region:account-id:cluster/*` - **dsql:AddPeerCluster** - When specifying `multiRegionProperties.clusters` , permission to add peer clusters.
Resources:
- Local cluster: `arn:aws:dsql:region:account-id:cluster/*` - Each peer cluster: exact ARN of each specified peer cluster - **dsql:PutWitnessRegion** - When specifying `multiRegionProperties.witnessRegion` , permission to set a witness Region. This permission is checked both in the cluster Region and in the witness Region.
Resources: `arn:aws:dsql:region:account-id:cluster/*`
Condition Keys: `dsql:WitnessRegion` (matching the specified witness region).
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCluster := awscdk.Aws_dsql.NewCfnCluster(this, jsii.String("MyCfnCluster"), &CfnClusterProps{
DeletionProtectionEnabled: jsii.Boolean(false),
KmsEncryptionKey: jsii.String("kmsEncryptionKey"),
MultiRegionProperties: &MultiRegionPropertiesProperty{
Clusters: []*string{
jsii.String("clusters"),
},
WitnessRegion: jsii.String("witnessRegion"),
},
PolicyDocument: jsii.String("policyDocument"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html
func NewCfnCluster ¶
func NewCfnCluster(scope constructs.Construct, id *string, props *CfnClusterProps) CfnCluster
Create a new `AWS::DSQL::Cluster`.
type CfnClusterProps ¶
type CfnClusterProps struct {
// Whether deletion protection is enabled on this cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-deletionprotectionenabled
//
DeletionProtectionEnabled interface{} `field:"optional" json:"deletionProtectionEnabled" yaml:"deletionProtectionEnabled"`
// The KMS key that encrypts data on the cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-kmsencryptionkey
//
KmsEncryptionKey *string `field:"optional" json:"kmsEncryptionKey" yaml:"kmsEncryptionKey"`
// Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-multiregionproperties
//
MultiRegionProperties interface{} `field:"optional" json:"multiRegionProperties" yaml:"multiRegionProperties"`
// The IAM policy applied to the cluster resource.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-policydocument
//
PolicyDocument *string `field:"optional" json:"policyDocument" yaml:"policyDocument"`
// A map of key and value pairs this cluster is tagged with.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html#cfn-dsql-cluster-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCluster`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnClusterProps := &CfnClusterProps{
DeletionProtectionEnabled: jsii.Boolean(false),
KmsEncryptionKey: jsii.String("kmsEncryptionKey"),
MultiRegionProperties: &MultiRegionPropertiesProperty{
Clusters: []*string{
jsii.String("clusters"),
},
WitnessRegion: jsii.String("witnessRegion"),
},
PolicyDocument: jsii.String("policyDocument"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-dsql-cluster.html
type CfnCluster_EncryptionDetailsProperty ¶ added in v2.203.0
type CfnCluster_EncryptionDetailsProperty struct {
// The status of encryption for the cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-encryptiondetails.html#cfn-dsql-cluster-encryptiondetails-encryptionstatus
//
EncryptionStatus *string `field:"optional" json:"encryptionStatus" yaml:"encryptionStatus"`
// The type of encryption that protects the data on your cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-encryptiondetails.html#cfn-dsql-cluster-encryptiondetails-encryptiontype
//
EncryptionType *string `field:"optional" json:"encryptionType" yaml:"encryptionType"`
// The ARN of the AWS KMS key that encrypts data in the cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-encryptiondetails.html#cfn-dsql-cluster-encryptiondetails-kmskeyarn
//
KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"`
}
Configuration details about encryption for the cluster including the AWS KMS key ARN, encryption type, and encryption status.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
encryptionDetailsProperty := &EncryptionDetailsProperty{
EncryptionStatus: jsii.String("encryptionStatus"),
EncryptionType: jsii.String("encryptionType"),
KmsKeyArn: jsii.String("kmsKeyArn"),
}
type CfnCluster_MultiRegionPropertiesProperty ¶ added in v2.201.0
type CfnCluster_MultiRegionPropertiesProperty struct {
// The set of peered clusters that form the multi-Region cluster configuration.
//
// Each peered cluster represents a database instance in a different Region.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-multiregionproperties.html#cfn-dsql-cluster-multiregionproperties-clusters
//
Clusters *[]*string `field:"optional" json:"clusters" yaml:"clusters"`
// The Region that serves as the witness Region for a multi-Region cluster.
//
// The witness Region helps maintain cluster consistency and quorum.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-dsql-cluster-multiregionproperties.html#cfn-dsql-cluster-multiregionproperties-witnessregion
//
WitnessRegion *string `field:"optional" json:"witnessRegion" yaml:"witnessRegion"`
}
Defines the structure for multi-Region cluster configurations, containing the witness Region and peered cluster settings.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
multiRegionPropertiesProperty := &MultiRegionPropertiesProperty{
Clusters: []*string{
jsii.String("clusters"),
},
WitnessRegion: jsii.String("witnessRegion"),
}