Documentation ¶
Index ¶
- func CfnDBClusterParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDBClusterParameterGroup_IsCfnElement(x interface{}) *bool
- func CfnDBClusterParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDBClusterParameterGroup_IsConstruct(x interface{}) *bool
- func CfnDBCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDBCluster_IsCfnElement(x interface{}) *bool
- func CfnDBCluster_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDBCluster_IsConstruct(x interface{}) *bool
- func CfnDBInstance_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDBInstance_IsCfnElement(x interface{}) *bool
- func CfnDBInstance_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDBInstance_IsConstruct(x interface{}) *bool
- func CfnDBParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDBParameterGroup_IsCfnElement(x interface{}) *bool
- func CfnDBParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDBParameterGroup_IsConstruct(x interface{}) *bool
- func CfnDBSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDBSubnetGroup_IsCfnElement(x interface{}) *bool
- func CfnDBSubnetGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnDBSubnetGroup_IsConstruct(x interface{}) *bool
- func ClusterParameterGroup_IsConstruct(x interface{}) *bool
- func ClusterParameterGroup_IsResource(construct awscdk.IConstruct) *bool
- func DatabaseClusterBase_IsConstruct(x interface{}) *bool
- func DatabaseClusterBase_IsResource(construct awscdk.IConstruct) *bool
- func DatabaseCluster_DEFAULT_NUM_INSTANCES() *float64
- func DatabaseCluster_IsConstruct(x interface{}) *bool
- func DatabaseCluster_IsResource(construct awscdk.IConstruct) *bool
- func DatabaseInstance_IsConstruct(x interface{}) *bool
- func DatabaseInstance_IsResource(construct awscdk.IConstruct) *bool
- func NewCfnDBClusterParameterGroup_Override(c CfnDBClusterParameterGroup, scope awscdk.Construct, id *string, ...)
- func NewCfnDBCluster_Override(c CfnDBCluster, scope awscdk.Construct, id *string, props *CfnDBClusterProps)
- func NewCfnDBInstance_Override(c CfnDBInstance, scope awscdk.Construct, id *string, props *CfnDBInstanceProps)
- func NewCfnDBParameterGroup_Override(c CfnDBParameterGroup, scope awscdk.Construct, id *string, ...)
- func NewCfnDBSubnetGroup_Override(c CfnDBSubnetGroup, scope awscdk.Construct, id *string, ...)
- func NewClusterParameterGroup_Override(c ClusterParameterGroup, scope constructs.Construct, id *string, ...)
- func NewDatabaseClusterBase_Override(d DatabaseClusterBase, scope constructs.Construct, id *string, ...)
- func NewDatabaseCluster_Override(d DatabaseCluster, scope constructs.Construct, id *string, ...)
- func NewDatabaseInstance_Override(d DatabaseInstance, scope constructs.Construct, id *string, ...)
- func NewEndpoint_Override(e Endpoint, address *string, port *float64)
- func NewEngineVersion_Override(e EngineVersion, version *string)
- func NewParameterGroup_Override(p ParameterGroup, scope constructs.Construct, id *string, ...)
- func NewSubnetGroup_Override(s SubnetGroup, scope constructs.Construct, id *string, props *SubnetGroupProps)
- func ParameterGroup_IsConstruct(x interface{}) *bool
- func ParameterGroup_IsResource(construct awscdk.IConstruct) *bool
- func SubnetGroup_IsConstruct(x interface{}) *bool
- func SubnetGroup_IsResource(construct awscdk.IConstruct) *bool
- type CfnDBCluster
- type CfnDBClusterParameterGroup
- type CfnDBClusterParameterGroupProps
- type CfnDBClusterProps
- type CfnDBCluster_DBClusterRoleProperty
- type CfnDBInstance
- type CfnDBInstanceProps
- type CfnDBParameterGroup
- type CfnDBParameterGroupProps
- type CfnDBSubnetGroup
- type CfnDBSubnetGroupProps
- type ClusterParameterGroup
- type ClusterParameterGroupProps
- type DatabaseCluster
- type DatabaseClusterAttributes
- type DatabaseClusterBase
- type DatabaseClusterProps
- type DatabaseInstance
- type DatabaseInstanceAttributes
- type DatabaseInstanceProps
- type Endpoint
- type EngineVersion
- func EngineVersion_V1_0_1_0() EngineVersion
- func EngineVersion_V1_0_1_1() EngineVersion
- func EngineVersion_V1_0_1_2() EngineVersion
- func EngineVersion_V1_0_2_1() EngineVersion
- func EngineVersion_V1_0_2_2() EngineVersion
- func EngineVersion_V1_0_3_0() EngineVersion
- func EngineVersion_V1_0_4_0() EngineVersion
- func EngineVersion_V1_0_4_1() EngineVersion
- func EngineVersion_V1_0_5_0() EngineVersion
- func EngineVersion_V1_1_0_0() EngineVersion
- func NewEngineVersion(version *string) EngineVersion
- type IClusterParameterGroup
- type IDatabaseCluster
- type IDatabaseInstance
- type IParameterGroup
- type ISubnetGroup
- type InstanceType
- func InstanceType_Of(instanceType *string) InstanceType
- func InstanceType_R4_2XLARGE() InstanceType
- func InstanceType_R4_4XLARGE() InstanceType
- func InstanceType_R4_8XLARGE() InstanceType
- func InstanceType_R4_LARGE() InstanceType
- func InstanceType_R4_XLARGE() InstanceType
- func InstanceType_R5_12XLARGE() InstanceType
- func InstanceType_R5_24XLARGE() InstanceType
- func InstanceType_R5_2XLARGE() InstanceType
- func InstanceType_R5_4XLARGE() InstanceType
- func InstanceType_R5_8XLARGE() InstanceType
- func InstanceType_R5_LARGE() InstanceType
- func InstanceType_R5_XLARGE() InstanceType
- func InstanceType_R6G_12XLARGE() InstanceType
- func InstanceType_R6G_16XLARGE() InstanceType
- func InstanceType_R6G_2XLARGE() InstanceType
- func InstanceType_R6G_4XLARGE() InstanceType
- func InstanceType_R6G_8XLARGE() InstanceType
- func InstanceType_R6G_LARGE() InstanceType
- func InstanceType_R6G_XLARGE() InstanceType
- func InstanceType_T3_MEDIUM() InstanceType
- func InstanceType_T4G_MEDIUM() InstanceType
- type ParameterGroup
- type ParameterGroupProps
- type SubnetGroup
- type SubnetGroupProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnDBClusterParameterGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnDBClusterParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnDBClusterParameterGroup_IsCfnElement ¶
func CfnDBClusterParameterGroup_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. Experimental.
func CfnDBClusterParameterGroup_IsCfnResource ¶
func CfnDBClusterParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDBClusterParameterGroup_IsConstruct ¶
func CfnDBClusterParameterGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnDBCluster_CFN_RESOURCE_TYPE_NAME ¶
func CfnDBCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnDBCluster_IsCfnElement ¶
func CfnDBCluster_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. Experimental.
func CfnDBCluster_IsCfnResource ¶
func CfnDBCluster_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDBCluster_IsConstruct ¶
func CfnDBCluster_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnDBInstance_CFN_RESOURCE_TYPE_NAME ¶
func CfnDBInstance_CFN_RESOURCE_TYPE_NAME() *string
func CfnDBInstance_IsCfnElement ¶
func CfnDBInstance_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. Experimental.
func CfnDBInstance_IsCfnResource ¶
func CfnDBInstance_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDBInstance_IsConstruct ¶
func CfnDBInstance_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnDBParameterGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnDBParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnDBParameterGroup_IsCfnElement ¶
func CfnDBParameterGroup_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. Experimental.
func CfnDBParameterGroup_IsCfnResource ¶
func CfnDBParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDBParameterGroup_IsConstruct ¶
func CfnDBParameterGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnDBSubnetGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnDBSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnDBSubnetGroup_IsCfnElement ¶
func CfnDBSubnetGroup_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. Experimental.
func CfnDBSubnetGroup_IsCfnResource ¶
func CfnDBSubnetGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnDBSubnetGroup_IsConstruct ¶
func CfnDBSubnetGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func ClusterParameterGroup_IsConstruct ¶
func ClusterParameterGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func ClusterParameterGroup_IsResource ¶
func ClusterParameterGroup_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func DatabaseClusterBase_IsConstruct ¶
func DatabaseClusterBase_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func DatabaseClusterBase_IsResource ¶
func DatabaseClusterBase_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func DatabaseCluster_DEFAULT_NUM_INSTANCES ¶
func DatabaseCluster_DEFAULT_NUM_INSTANCES() *float64
func DatabaseCluster_IsConstruct ¶
func DatabaseCluster_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func DatabaseCluster_IsResource ¶
func DatabaseCluster_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func DatabaseInstance_IsConstruct ¶
func DatabaseInstance_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func DatabaseInstance_IsResource ¶
func DatabaseInstance_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func NewCfnDBClusterParameterGroup_Override ¶
func NewCfnDBClusterParameterGroup_Override(c CfnDBClusterParameterGroup, scope awscdk.Construct, id *string, props *CfnDBClusterParameterGroupProps)
Create a new `AWS::Neptune::DBClusterParameterGroup`.
func NewCfnDBCluster_Override ¶
func NewCfnDBCluster_Override(c CfnDBCluster, scope awscdk.Construct, id *string, props *CfnDBClusterProps)
Create a new `AWS::Neptune::DBCluster`.
func NewCfnDBInstance_Override ¶
func NewCfnDBInstance_Override(c CfnDBInstance, scope awscdk.Construct, id *string, props *CfnDBInstanceProps)
Create a new `AWS::Neptune::DBInstance`.
func NewCfnDBParameterGroup_Override ¶
func NewCfnDBParameterGroup_Override(c CfnDBParameterGroup, scope awscdk.Construct, id *string, props *CfnDBParameterGroupProps)
Create a new `AWS::Neptune::DBParameterGroup`.
func NewCfnDBSubnetGroup_Override ¶
func NewCfnDBSubnetGroup_Override(c CfnDBSubnetGroup, scope awscdk.Construct, id *string, props *CfnDBSubnetGroupProps)
Create a new `AWS::Neptune::DBSubnetGroup`.
func NewClusterParameterGroup_Override ¶
func NewClusterParameterGroup_Override(c ClusterParameterGroup, scope constructs.Construct, id *string, props *ClusterParameterGroupProps)
Experimental.
func NewDatabaseClusterBase_Override ¶
func NewDatabaseClusterBase_Override(d DatabaseClusterBase, scope constructs.Construct, id *string, props *awscdk.ResourceProps)
Experimental.
func NewDatabaseCluster_Override ¶
func NewDatabaseCluster_Override(d DatabaseCluster, scope constructs.Construct, id *string, props *DatabaseClusterProps)
Experimental.
func NewDatabaseInstance_Override ¶
func NewDatabaseInstance_Override(d DatabaseInstance, scope constructs.Construct, id *string, props *DatabaseInstanceProps)
Experimental.
func NewEndpoint_Override ¶
Experimental.
func NewEngineVersion_Override ¶
func NewEngineVersion_Override(e EngineVersion, version *string)
Constructor for specifying a custom engine version. Experimental.
func NewParameterGroup_Override ¶
func NewParameterGroup_Override(p ParameterGroup, scope constructs.Construct, id *string, props *ParameterGroupProps)
Experimental.
func NewSubnetGroup_Override ¶
func NewSubnetGroup_Override(s SubnetGroup, scope constructs.Construct, id *string, props *SubnetGroupProps)
Experimental.
func ParameterGroup_IsConstruct ¶
func ParameterGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func ParameterGroup_IsResource ¶
func ParameterGroup_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
func SubnetGroup_IsConstruct ¶
func SubnetGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func SubnetGroup_IsResource ¶
func SubnetGroup_IsResource(construct awscdk.IConstruct) *bool
Check whether the given construct is a Resource. Experimental.
Types ¶
type CfnDBCluster ¶
type CfnDBCluster interface { awscdk.CfnResource awscdk.IInspectable // Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. // // IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf. AssociatedRoles() interface{} SetAssociatedRoles(val interface{}) // The resource id for the DB cluster. // // For example: `cluster-ABCD1234EFGH5678IJKL90MNOP` . The cluster ID uniquely identifies the cluster and is used in things like IAM authentication policies. AttrClusterResourceId() *string // The connection endpoint for the DB cluster. // // For example: `mystack-mydbcluster-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com` AttrEndpoint() *string // The port number on which the DB cluster accepts connections. // // For example: `8182` . AttrPort() *string // The reader endpoint for the DB cluster. // // For example: `mystack-mydbcluster-ro-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com` AttrReadEndpoint() *string // Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. AvailabilityZones() *[]*string SetAvailabilityZones(val *[]*string) // Specifies the number of days for which automatic DB snapshots are retained. // // An update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance) in the Amazon Neptune User Guide for more information. BackupRetentionPeriod() *float64 SetBackupRetentionPeriod(val *float64) // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. CfnResourceType() *string // 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. // Experimental. CreationStack() *[]*string // Contains a user-supplied DB cluster identifier. // // This identifier is the unique key that identifies a DB cluster. DbClusterIdentifier() *string SetDbClusterIdentifier(val *string) // Provides the name of the DB cluster parameter group. // // An update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance) in the Amazon Neptune User Guide for more information. DbClusterParameterGroupName() *string SetDbClusterParameterGroupName(val *string) // Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. DbSubnetGroupName() *string SetDbSubnetGroupName(val *string) // Indicates whether or not the DB cluster has deletion protection enabled. // // The database can't be deleted when deletion protection is enabled. DeletionProtection() interface{} SetDeletionProtection(val interface{}) // Specifies a list of log types that are enabled for export to CloudWatch Logs. EnableCloudwatchLogsExports() *[]*string SetEnableCloudwatchLogsExports(val *[]*string) // Indicates the database engine version. EngineVersion() *string SetEngineVersion(val *string) // True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. IamAuthEnabled() interface{} SetIamAuthEnabled(val interface{}) // If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster. KmsKeyId() *string SetKmsKeyId(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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // Specifies the port that the database engine is listening on. Port() *float64 SetPort(val *float64) // Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` . // // An update may require some interruption. PreferredBackupWindow() *string SetPreferredBackupWindow(val *string) // Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). PreferredMaintenanceWindow() *string SetPreferredMaintenanceWindow(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 })`. // Experimental. Ref() *string // Creates a new DB cluster from a DB snapshot or DB cluster snapshot. // // If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. // // If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. RestoreToTime() *string SetRestoreToTime(val *string) // Creates a new DB cluster from a DB snapshot or DB cluster snapshot. // // If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. // // If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. RestoreType() *string SetRestoreType(val *string) // Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. // // After you restore a DB cluster using a `SnapshotIdentifier` , you must specify the same `SnapshotIdentifier` for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. // // However, if you don't specify the `SnapshotIdentifier` , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the `SnapshotIdentifier` , and the original DB cluster is deleted. SnapshotIdentifier() *string SetSnapshotIdentifier(val *string) // Creates a new DB cluster from a DB snapshot or DB cluster snapshot. // // If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. // // If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. SourceDbClusterIdentifier() *string SetSourceDbClusterIdentifier(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // Indicates whether the DB cluster is encrypted. // // If you specify the `DBClusterIdentifier` , `DBSnapshotIdentifier` , or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the `KmsKeyId` property, you must enable encryption. // // If you specify the `KmsKeyId` , you must enable encryption by setting `StorageEncrypted` to true. StorageEncrypted() interface{} SetStorageEncrypted(val interface{}) // The tags assigned to this cluster. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Creates a new DB cluster from a DB snapshot or DB cluster snapshot. // // If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. // // If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. UseLatestRestorableTime() interface{} SetUseLatestRestorableTime(val interface{}) // Provides a list of VPC security groups that the DB cluster belongs to. VpcSecurityGroupIds() *[]*string SetVpcSecurityGroupIds(val *[]*string) // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Neptune::DBCluster`.
The `AWS::Neptune::DBCluster` resource creates an Amazon Neptune DB cluster. Neptune is a fully managed graph database.
> Currently, you can create this resource only in AWS Regions in which Amazon Neptune is supported.
If no `DeletionPolicy` is set for `AWS::Neptune::DBCluster` resources, the default deletion behavior is that the entire volume will be deleted without a snapshot. To retain a backup of the volume, the `DeletionPolicy` should be set to `Snapshot` . For more information about how AWS CloudFormation deletes resources, see [DeletionPolicy Attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html) .
You can use `AWS::Neptune::DBCluster.DeletionProtection` to help guard against unintended deletion of your DB cluster.
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" cfnDBCluster := awscdk.Aws_neptune.NewCfnDBCluster(this, jsii.String("MyCfnDBCluster"), &cfnDBClusterProps{ associatedRoles: []interface{}{ &dBClusterRoleProperty{ roleArn: jsii.String("roleArn"), // the properties below are optional featureName: jsii.String("featureName"), }, }, availabilityZones: []*string{ jsii.String("availabilityZones"), }, backupRetentionPeriod: jsii.Number(123), dbClusterIdentifier: jsii.String("dbClusterIdentifier"), dbClusterParameterGroupName: jsii.String("dbClusterParameterGroupName"), dbSubnetGroupName: jsii.String("dbSubnetGroupName"), deletionProtection: jsii.Boolean(false), enableCloudwatchLogsExports: []*string{ jsii.String("enableCloudwatchLogsExports"), }, engineVersion: jsii.String("engineVersion"), iamAuthEnabled: jsii.Boolean(false), kmsKeyId: jsii.String("kmsKeyId"), port: jsii.Number(123), preferredBackupWindow: jsii.String("preferredBackupWindow"), preferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), restoreToTime: jsii.String("restoreToTime"), restoreType: jsii.String("restoreType"), snapshotIdentifier: jsii.String("snapshotIdentifier"), sourceDbClusterIdentifier: jsii.String("sourceDbClusterIdentifier"), storageEncrypted: jsii.Boolean(false), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, useLatestRestorableTime: jsii.Boolean(false), vpcSecurityGroupIds: []*string{ jsii.String("vpcSecurityGroupIds"), }, })
func NewCfnDBCluster ¶
func NewCfnDBCluster(scope awscdk.Construct, id *string, props *CfnDBClusterProps) CfnDBCluster
Create a new `AWS::Neptune::DBCluster`.
type CfnDBClusterParameterGroup ¶
type CfnDBClusterParameterGroup interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. CfnResourceType() *string // 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. // Experimental. CreationStack() *[]*string // Provides the customer-specified description for this DB cluster parameter group. Description() *string SetDescription(val *string) // Must be `neptune1` for engine versions prior to [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) , or `neptune1.2` for engine version `1.2.0.0` and higher. Family() *string SetFamily(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. // Experimental. LogicalId() *string // Provides the name of the DB cluster parameter group. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // The parameters to set for this DB cluster parameter group. // // The parameters are expressed as a JSON object consisting of key-value pairs. // // If you update the parameters, some interruption may occur depending on which parameters you update. Parameters() interface{} SetParameters(val interface{}) // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // The tags that you want to attach to this parameter group. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Neptune::DBClusterParameterGroup`.
The `AWS::Neptune::DBClusterParameterGroup` resource creates a new Amazon Neptune DB cluster parameter group.
> Applying a parameter group to a DB cluster might require instances to reboot, resulting in a database outage while the instances reboot.
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" var parameters interface{} cfnDBClusterParameterGroup := awscdk.Aws_neptune.NewCfnDBClusterParameterGroup(this, jsii.String("MyCfnDBClusterParameterGroup"), &cfnDBClusterParameterGroupProps{ description: jsii.String("description"), family: jsii.String("family"), parameters: parameters, // the properties below are optional name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnDBClusterParameterGroup ¶
func NewCfnDBClusterParameterGroup(scope awscdk.Construct, id *string, props *CfnDBClusterParameterGroupProps) CfnDBClusterParameterGroup
Create a new `AWS::Neptune::DBClusterParameterGroup`.
type CfnDBClusterParameterGroupProps ¶
type CfnDBClusterParameterGroupProps struct { // Provides the customer-specified description for this DB cluster parameter group. Description *string `field:"required" json:"description" yaml:"description"` // Must be `neptune1` for engine versions prior to [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) , or `neptune1.2` for engine version `1.2.0.0` and higher. Family *string `field:"required" json:"family" yaml:"family"` // The parameters to set for this DB cluster parameter group. // // The parameters are expressed as a JSON object consisting of key-value pairs. // // If you update the parameters, some interruption may occur depending on which parameters you update. Parameters interface{} `field:"required" json:"parameters" yaml:"parameters"` // Provides the name of the DB cluster parameter group. Name *string `field:"optional" json:"name" yaml:"name"` // The tags that you want to attach to this parameter group. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDBClusterParameterGroup`.
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" var parameters interface{} cfnDBClusterParameterGroupProps := &cfnDBClusterParameterGroupProps{ description: jsii.String("description"), family: jsii.String("family"), parameters: parameters, // the properties below are optional name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnDBClusterProps ¶
type CfnDBClusterProps struct { // Provides a list of the Amazon Identity and Access Management (IAM) roles that are associated with the DB cluster. // // IAM roles that are associated with a DB cluster grant permission for the DB cluster to access other Amazon services on your behalf. AssociatedRoles interface{} `field:"optional" json:"associatedRoles" yaml:"associatedRoles"` // Provides the list of EC2 Availability Zones that instances in the DB cluster can be created in. AvailabilityZones *[]*string `field:"optional" json:"availabilityZones" yaml:"availabilityZones"` // Specifies the number of days for which automatic DB snapshots are retained. // // An update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance) in the Amazon Neptune User Guide for more information. BackupRetentionPeriod *float64 `field:"optional" json:"backupRetentionPeriod" yaml:"backupRetentionPeriod"` // Contains a user-supplied DB cluster identifier. // // This identifier is the unique key that identifies a DB cluster. DbClusterIdentifier *string `field:"optional" json:"dbClusterIdentifier" yaml:"dbClusterIdentifier"` // Provides the name of the DB cluster parameter group. // // An update may require some interruption. See [ModifyDBInstance](https://docs.aws.amazon.com/neptune/latest/userguide/api-instances.html#ModifyDBInstance) in the Amazon Neptune User Guide for more information. DbClusterParameterGroupName *string `field:"optional" json:"dbClusterParameterGroupName" yaml:"dbClusterParameterGroupName"` // Specifies information on the subnet group associated with the DB cluster, including the name, description, and subnets in the subnet group. DbSubnetGroupName *string `field:"optional" json:"dbSubnetGroupName" yaml:"dbSubnetGroupName"` // Indicates whether or not the DB cluster has deletion protection enabled. // // The database can't be deleted when deletion protection is enabled. DeletionProtection interface{} `field:"optional" json:"deletionProtection" yaml:"deletionProtection"` // Specifies a list of log types that are enabled for export to CloudWatch Logs. EnableCloudwatchLogsExports *[]*string `field:"optional" json:"enableCloudwatchLogsExports" yaml:"enableCloudwatchLogsExports"` // Indicates the database engine version. EngineVersion *string `field:"optional" json:"engineVersion" yaml:"engineVersion"` // True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false. IamAuthEnabled interface{} `field:"optional" json:"iamAuthEnabled" yaml:"iamAuthEnabled"` // If `StorageEncrypted` is true, the Amazon KMS key identifier for the encrypted DB cluster. KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"` // Specifies the port that the database engine is listening on. Port *float64 `field:"optional" json:"port" yaml:"port"` // Specifies the daily time range during which automated backups are created if automated backups are enabled, as determined by the `BackupRetentionPeriod` . // // An update may require some interruption. PreferredBackupWindow *string `field:"optional" json:"preferredBackupWindow" yaml:"preferredBackupWindow"` // Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). PreferredMaintenanceWindow *string `field:"optional" json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"` // Creates a new DB cluster from a DB snapshot or DB cluster snapshot. // // If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. // // If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. RestoreToTime *string `field:"optional" json:"restoreToTime" yaml:"restoreToTime"` // Creates a new DB cluster from a DB snapshot or DB cluster snapshot. // // If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. // // If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. RestoreType *string `field:"optional" json:"restoreType" yaml:"restoreType"` // Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot. // // After you restore a DB cluster using a `SnapshotIdentifier` , you must specify the same `SnapshotIdentifier` for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed. // // However, if you don't specify the `SnapshotIdentifier` , an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by the `SnapshotIdentifier` , and the original DB cluster is deleted. SnapshotIdentifier *string `field:"optional" json:"snapshotIdentifier" yaml:"snapshotIdentifier"` // Creates a new DB cluster from a DB snapshot or DB cluster snapshot. // // If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. // // If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. SourceDbClusterIdentifier *string `field:"optional" json:"sourceDbClusterIdentifier" yaml:"sourceDbClusterIdentifier"` // Indicates whether the DB cluster is encrypted. // // If you specify the `DBClusterIdentifier` , `DBSnapshotIdentifier` , or `SourceDBInstanceIdentifier` property, don't specify this property. The value is inherited from the cluster, snapshot, or source DB instance. If you specify the `KmsKeyId` property, you must enable encryption. // // If you specify the `KmsKeyId` , you must enable encryption by setting `StorageEncrypted` to true. StorageEncrypted interface{} `field:"optional" json:"storageEncrypted" yaml:"storageEncrypted"` // The tags assigned to this cluster. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` // Creates a new DB cluster from a DB snapshot or DB cluster snapshot. // // If a DB snapshot is specified, the target DB cluster is created from the source DB snapshot with a default configuration and default security group. // // If a DB cluster snapshot is specified, the target DB cluster is created from the source DB cluster restore point with the same configuration as the original source DB cluster, except that the new DB cluster is created with the default security group. UseLatestRestorableTime interface{} `field:"optional" json:"useLatestRestorableTime" yaml:"useLatestRestorableTime"` // Provides a list of VPC security groups that the DB cluster belongs to. VpcSecurityGroupIds *[]*string `field:"optional" json:"vpcSecurityGroupIds" yaml:"vpcSecurityGroupIds"` }
Properties for defining a `CfnDBCluster`.
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" cfnDBClusterProps := &cfnDBClusterProps{ associatedRoles: []interface{}{ &dBClusterRoleProperty{ roleArn: jsii.String("roleArn"), // the properties below are optional featureName: jsii.String("featureName"), }, }, availabilityZones: []*string{ jsii.String("availabilityZones"), }, backupRetentionPeriod: jsii.Number(123), dbClusterIdentifier: jsii.String("dbClusterIdentifier"), dbClusterParameterGroupName: jsii.String("dbClusterParameterGroupName"), dbSubnetGroupName: jsii.String("dbSubnetGroupName"), deletionProtection: jsii.Boolean(false), enableCloudwatchLogsExports: []*string{ jsii.String("enableCloudwatchLogsExports"), }, engineVersion: jsii.String("engineVersion"), iamAuthEnabled: jsii.Boolean(false), kmsKeyId: jsii.String("kmsKeyId"), port: jsii.Number(123), preferredBackupWindow: jsii.String("preferredBackupWindow"), preferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), restoreToTime: jsii.String("restoreToTime"), restoreType: jsii.String("restoreType"), snapshotIdentifier: jsii.String("snapshotIdentifier"), sourceDbClusterIdentifier: jsii.String("sourceDbClusterIdentifier"), storageEncrypted: jsii.Boolean(false), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, useLatestRestorableTime: jsii.Boolean(false), vpcSecurityGroupIds: []*string{ jsii.String("vpcSecurityGroupIds"), }, }
type CfnDBCluster_DBClusterRoleProperty ¶
type CfnDBCluster_DBClusterRoleProperty struct { // The Amazon Resource Name (ARN) of the IAM role that is associated with the DB cluster. RoleArn *string `field:"required" json:"roleArn" yaml:"roleArn"` // The name of the feature associated with the Amazon Identity and Access Management (IAM) role. // // For the list of supported feature names, see [DescribeDBEngineVersions](https://docs.aws.amazon.com/neptune/latest/userguide/api-other-apis.html#DescribeDBEngineVersions) . FeatureName *string `field:"optional" json:"featureName" yaml:"featureName"` }
Describes an Amazon Identity and Access Management (IAM) role that is associated with a DB cluster.
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" dBClusterRoleProperty := &dBClusterRoleProperty{ roleArn: jsii.String("roleArn"), // the properties below are optional featureName: jsii.String("featureName"), }
type CfnDBInstance ¶
type CfnDBInstance interface { awscdk.CfnResource awscdk.IInspectable // Indicates that major version upgrades are allowed. // // Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. AllowMajorVersionUpgrade() interface{} SetAllowMajorVersionUpgrade(val interface{}) // The connection endpoint for the database. // // For example: `mystack-mydb-1apw1j4phylrk.cg034hpkmmjt.us-east-2.rds.amazonaws.com` . AttrEndpoint() *string // The port number on which the database accepts connections. // // For example: `8182` . AttrPort() *string // Indicates that minor version patches are applied automatically. // // When updating this property, some interruptions may occur. AutoMinorVersionUpgrade() interface{} SetAutoMinorVersionUpgrade(val interface{}) // Specifies the name of the Availability Zone the DB instance is located in. AvailabilityZone() *string SetAvailabilityZone(val *string) // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. CfnResourceType() *string // 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. // Experimental. CreationStack() *[]*string // If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. DbClusterIdentifier() *string SetDbClusterIdentifier(val *string) // Contains the name of the compute and memory capacity class of the DB instance. // // If you update this property, some interruptions may occur. DbInstanceClass() *string SetDbInstanceClass(val *string) // Contains a user-supplied database identifier. // // This identifier is the unique key that identifies a DB instance. DbInstanceIdentifier() *string SetDbInstanceIdentifier(val *string) // The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. // // If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. DbParameterGroupName() *string SetDbParameterGroupName(val *string) // This parameter is not supported. // // `AWS::Neptune::DBInstance` does not support restoring from snapshots. // // `AWS::Neptune::DBCluster` does support restoring from snapshots. DbSnapshotIdentifier() *string SetDbSnapshotIdentifier(val *string) // A DB subnet group to associate with the DB instance. // // If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC). DbSubnetGroupName() *string SetDbSubnetGroupName(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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). PreferredMaintenanceWindow() *string SetPreferredMaintenanceWindow(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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // An arbitrary set of tags (key-value pairs) for this DB instance. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Neptune::DBInstance`.
The `AWS::Neptune::DBInstance` type creates an Amazon Neptune DB instance.
*Updating DB Instances*
You can set a deletion policy for your DB instance to control how AWS CloudFormation handles the instance when the stack is deleted. For Neptune DB instances, you can choose to *retain* the instance, to *delete* the instance, or to *create a snapshot* of the instance. The default AWS CloudFormation behavior depends on the `DBClusterIdentifier` property:
- For `AWS::Neptune::DBInstance` resources that don't specify the `DBClusterIdentifier` property, AWS CloudFormation saves a snapshot of the DB instance. - For `AWS::Neptune::DBInstance` resources that do specify the `DBClusterIdentifier` property, AWS CloudFormation deletes the DB instance.
*Deleting DB Instances*
> If a DB instance is deleted or replaced during an update, AWS CloudFormation deletes all automated snapshots. However, it retains manual DB snapshots. During an update that requires replacement, you can apply a stack policy to prevent DB instances from being replaced.
When properties labeled *Update requires: Replacement* are updated, AWS CloudFormation first creates a replacement DB instance, changes references from other dependent resources to point to the replacement DB instance, and finally deletes the old DB instance.
> We highly recommend that you take a snapshot of the database before updating the stack. If you don't, you lose the data when AWS CloudFormation replaces your DB instance. To preserve your data, perform the following procedure: > > - Deactivate any applications that are using the DB instance so that there's no activity on the DB instance. > - Create a snapshot of the DB instance. > - If you want to restore your instance using a DB snapshot, modify the updated template with your DB instance changes and add the `DBSnapshotIdentifier` property with the ID of the DB snapshot that you want to use. > - Update the stack.
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" cfnDBInstance := awscdk.Aws_neptune.NewCfnDBInstance(this, jsii.String("MyCfnDBInstance"), &cfnDBInstanceProps{ dbInstanceClass: jsii.String("dbInstanceClass"), // the properties below are optional allowMajorVersionUpgrade: jsii.Boolean(false), autoMinorVersionUpgrade: jsii.Boolean(false), availabilityZone: jsii.String("availabilityZone"), dbClusterIdentifier: jsii.String("dbClusterIdentifier"), dbInstanceIdentifier: jsii.String("dbInstanceIdentifier"), dbParameterGroupName: jsii.String("dbParameterGroupName"), dbSnapshotIdentifier: jsii.String("dbSnapshotIdentifier"), dbSubnetGroupName: jsii.String("dbSubnetGroupName"), preferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnDBInstance ¶
func NewCfnDBInstance(scope awscdk.Construct, id *string, props *CfnDBInstanceProps) CfnDBInstance
Create a new `AWS::Neptune::DBInstance`.
type CfnDBInstanceProps ¶
type CfnDBInstanceProps struct { // Contains the name of the compute and memory capacity class of the DB instance. // // If you update this property, some interruptions may occur. DbInstanceClass *string `field:"required" json:"dbInstanceClass" yaml:"dbInstanceClass"` // Indicates that major version upgrades are allowed. // // Changing this parameter doesn't result in an outage and the change is asynchronously applied as soon as possible. This parameter must be set to true when specifying a value for the EngineVersion parameter that is a different major version than the DB instance's current version. AllowMajorVersionUpgrade interface{} `field:"optional" json:"allowMajorVersionUpgrade" yaml:"allowMajorVersionUpgrade"` // Indicates that minor version patches are applied automatically. // // When updating this property, some interruptions may occur. AutoMinorVersionUpgrade interface{} `field:"optional" json:"autoMinorVersionUpgrade" yaml:"autoMinorVersionUpgrade"` // Specifies the name of the Availability Zone the DB instance is located in. AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"` // If the DB instance is a member of a DB cluster, contains the name of the DB cluster that the DB instance is a member of. DbClusterIdentifier *string `field:"optional" json:"dbClusterIdentifier" yaml:"dbClusterIdentifier"` // Contains a user-supplied database identifier. // // This identifier is the unique key that identifies a DB instance. DbInstanceIdentifier *string `field:"optional" json:"dbInstanceIdentifier" yaml:"dbInstanceIdentifier"` // The name of an existing DB parameter group or a reference to an AWS::Neptune::DBParameterGroup resource created in the template. // // If any of the data members of the referenced parameter group are changed during an update, the DB instance might need to be restarted, which causes some interruption. If the parameter group contains static parameters, whether they were changed or not, an update triggers a reboot. DbParameterGroupName *string `field:"optional" json:"dbParameterGroupName" yaml:"dbParameterGroupName"` // This parameter is not supported. // // `AWS::Neptune::DBInstance` does not support restoring from snapshots. // // `AWS::Neptune::DBCluster` does support restoring from snapshots. DbSnapshotIdentifier *string `field:"optional" json:"dbSnapshotIdentifier" yaml:"dbSnapshotIdentifier"` // A DB subnet group to associate with the DB instance. // // If you update this value, the new subnet group must be a subnet group in a new virtual private cloud (VPC). DbSubnetGroupName *string `field:"optional" json:"dbSubnetGroupName" yaml:"dbSubnetGroupName"` // Specifies the weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC). PreferredMaintenanceWindow *string `field:"optional" json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"` // An arbitrary set of tags (key-value pairs) for this DB instance. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDBInstance`.
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" cfnDBInstanceProps := &cfnDBInstanceProps{ dbInstanceClass: jsii.String("dbInstanceClass"), // the properties below are optional allowMajorVersionUpgrade: jsii.Boolean(false), autoMinorVersionUpgrade: jsii.Boolean(false), availabilityZone: jsii.String("availabilityZone"), dbClusterIdentifier: jsii.String("dbClusterIdentifier"), dbInstanceIdentifier: jsii.String("dbInstanceIdentifier"), dbParameterGroupName: jsii.String("dbParameterGroupName"), dbSnapshotIdentifier: jsii.String("dbSnapshotIdentifier"), dbSubnetGroupName: jsii.String("dbSubnetGroupName"), preferredMaintenanceWindow: jsii.String("preferredMaintenanceWindow"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnDBParameterGroup ¶
type CfnDBParameterGroup interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. CfnResourceType() *string // 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. // Experimental. CreationStack() *[]*string // Provides the customer-specified description for this DB parameter group. Description() *string SetDescription(val *string) // Must be `neptune1` for engine versions prior to [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) , or `neptune1.2` for engine version `1.2.0.0` and higher. Family() *string SetFamily(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. // Experimental. LogicalId() *string // Provides the name of the DB parameter group. Name() *string SetName(val *string) // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // The parameters to set for this DB parameter group. // // The parameters are expressed as a JSON object consisting of key-value pairs. // // Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover. Parameters() interface{} SetParameters(val interface{}) // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // The tags that you want to attach to this parameter group. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Neptune::DBParameterGroup`.
`AWS::Neptune::DBParameterGroup` creates a new DB parameter group. This type can be declared in a template and referenced in the `DBParameterGroupName` parameter of `AWS::Neptune::DBInstance` .
> Applying a parameter group to a DB instance might require the instance to reboot, resulting in a database outage for the duration of the reboot.
A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using *ModifyDBParameterGroup* . Once you've created a DB parameter group, you need to associate it with your DB instance using *ModifyDBInstance* . When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect.
> After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the `character_set_database` parameter. You can use the *Parameter Groups* option of the Amazon Neptune console or the *DescribeDBParameters* command to verify that your DB parameter group has been created or modified.
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" var parameters interface{} cfnDBParameterGroup := awscdk.Aws_neptune.NewCfnDBParameterGroup(this, jsii.String("MyCfnDBParameterGroup"), &cfnDBParameterGroupProps{ description: jsii.String("description"), family: jsii.String("family"), parameters: parameters, // the properties below are optional name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnDBParameterGroup ¶
func NewCfnDBParameterGroup(scope awscdk.Construct, id *string, props *CfnDBParameterGroupProps) CfnDBParameterGroup
Create a new `AWS::Neptune::DBParameterGroup`.
type CfnDBParameterGroupProps ¶
type CfnDBParameterGroupProps struct { // Provides the customer-specified description for this DB parameter group. Description *string `field:"required" json:"description" yaml:"description"` // Must be `neptune1` for engine versions prior to [1.2.0.0](https://docs.aws.amazon.com/neptune/latest/userguide/engine-releases-1.2.0.0.html) , or `neptune1.2` for engine version `1.2.0.0` and higher. Family *string `field:"required" json:"family" yaml:"family"` // The parameters to set for this DB parameter group. // // The parameters are expressed as a JSON object consisting of key-value pairs. // // Changes to dynamic parameters are applied immediately. During an update, if you have static parameters (whether they were changed or not), it triggers AWS CloudFormation to reboot the associated DB instance without failover. Parameters interface{} `field:"required" json:"parameters" yaml:"parameters"` // Provides the name of the DB parameter group. Name *string `field:"optional" json:"name" yaml:"name"` // The tags that you want to attach to this parameter group. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDBParameterGroup`.
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" var parameters interface{} cfnDBParameterGroupProps := &cfnDBParameterGroupProps{ description: jsii.String("description"), family: jsii.String("family"), parameters: parameters, // the properties below are optional name: jsii.String("name"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type CfnDBSubnetGroup ¶
type CfnDBSubnetGroup interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. // Experimental. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. // Experimental. CfnResourceType() *string // 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. // Experimental. CreationStack() *[]*string // Provides the description of the DB subnet group. DbSubnetGroupDescription() *string SetDbSubnetGroupDescription(val *string) // The name of the DB subnet group. DbSubnetGroupName() *string SetDbSubnetGroupName(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. // Experimental. LogicalId() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // 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 })`. // Experimental. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). // Experimental. Stack() awscdk.Stack // The Amazon EC2 subnet IDs for the DB subnet group. SubnetIds() *[]*string SetSubnetIds(val *[]*string) // The tags that you want to attach to the DB subnet group. Tags() awscdk.TagManager // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. // Experimental. UpdatedProperites() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. // Experimental. 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. // Experimental. 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. // // Experimental. 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. // Experimental. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. // Experimental. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. // Experimental. 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`). // Experimental. 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. // Experimental. GetAtt(attributeName *string) 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. // // Experimental. GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Overrides the auto-generated logical ID with a specific ID. // Experimental. OverrideLogicalId(newLogicalId *string) // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() RenderProperties(props *map[string]interface{}) *map[string]interface{} // 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. // Experimental. ShouldSynthesize() *bool // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // // Returns: a string representation of this resource. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string // Experimental. ValidateProperties(_properties interface{}) }
A CloudFormation `AWS::Neptune::DBSubnetGroup`.
The `AWS::Neptune::DBSubnetGroup` type creates an Amazon Neptune DB subnet group. Subnet groups must contain at least two subnets in two different Availability Zones in the same AWS 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" cfnDBSubnetGroup := awscdk.Aws_neptune.NewCfnDBSubnetGroup(this, jsii.String("MyCfnDBSubnetGroup"), &cfnDBSubnetGroupProps{ dbSubnetGroupDescription: jsii.String("dbSubnetGroupDescription"), subnetIds: []*string{ jsii.String("subnetIds"), }, // the properties below are optional dbSubnetGroupName: jsii.String("dbSubnetGroupName"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, })
func NewCfnDBSubnetGroup ¶
func NewCfnDBSubnetGroup(scope awscdk.Construct, id *string, props *CfnDBSubnetGroupProps) CfnDBSubnetGroup
Create a new `AWS::Neptune::DBSubnetGroup`.
type CfnDBSubnetGroupProps ¶
type CfnDBSubnetGroupProps struct { // Provides the description of the DB subnet group. DbSubnetGroupDescription *string `field:"required" json:"dbSubnetGroupDescription" yaml:"dbSubnetGroupDescription"` // The Amazon EC2 subnet IDs for the DB subnet group. SubnetIds *[]*string `field:"required" json:"subnetIds" yaml:"subnetIds"` // The name of the DB subnet group. DbSubnetGroupName *string `field:"optional" json:"dbSubnetGroupName" yaml:"dbSubnetGroupName"` // The tags that you want to attach to the DB subnet group. Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDBSubnetGroup`.
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" cfnDBSubnetGroupProps := &cfnDBSubnetGroupProps{ dbSubnetGroupDescription: jsii.String("dbSubnetGroupDescription"), subnetIds: []*string{ jsii.String("subnetIds"), }, // the properties below are optional dbSubnetGroupName: jsii.String("dbSubnetGroupName"), tags: []cfnTag{ &cfnTag{ key: jsii.String("key"), value: jsii.String("value"), }, }, }
type ClusterParameterGroup ¶
type ClusterParameterGroup interface { awscdk.Resource IClusterParameterGroup // The name of the parameter group. // Experimental. ClusterParameterGroupName() *string // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. // Experimental. Env() *awscdk.ResourceEnvironment // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string // The stack in which this resource is defined. // Experimental. Stack() awscdk.Stack // Apply the given removal policy to this resource. // // 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`). // Experimental. ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Experimental. GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. // Experimental. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. // Experimental. GetResourceNameAttribute(nameAttr *string) *string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string }
A cluster parameter group.
Example:
clusterParams := neptune.NewClusterParameterGroup(this, jsii.String("ClusterParams"), &clusterParameterGroupProps{ description: jsii.String("Cluster parameter group"), parameters: map[string]*string{ "neptune_enable_audit_log": jsii.String("1"), }, }) dbParams := neptune.NewParameterGroup(this, jsii.String("DbParams"), ¶meterGroupProps{ description: jsii.String("Db parameter group"), parameters: map[string]*string{ "neptune_query_timeout": jsii.String("120000"), }, }) cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &databaseClusterProps{ vpc: vpc, instanceType: neptune.instanceType_R5_LARGE(), clusterParameterGroup: clusterParams, parameterGroup: dbParams, })
Experimental.
func NewClusterParameterGroup ¶
func NewClusterParameterGroup(scope constructs.Construct, id *string, props *ClusterParameterGroupProps) ClusterParameterGroup
Experimental.
type ClusterParameterGroupProps ¶
type ClusterParameterGroupProps struct { // The parameters in this parameter group. // Experimental. Parameters *map[string]*string `field:"required" json:"parameters" yaml:"parameters"` // The name of the parameter group. // Experimental. ClusterParameterGroupName *string `field:"optional" json:"clusterParameterGroupName" yaml:"clusterParameterGroupName"` // Description for this parameter group. // Experimental. Description *string `field:"optional" json:"description" yaml:"description"` }
Marker class for cluster parameter group.
Example:
clusterParams := neptune.NewClusterParameterGroup(this, jsii.String("ClusterParams"), &clusterParameterGroupProps{ description: jsii.String("Cluster parameter group"), parameters: map[string]*string{ "neptune_enable_audit_log": jsii.String("1"), }, }) dbParams := neptune.NewParameterGroup(this, jsii.String("DbParams"), ¶meterGroupProps{ description: jsii.String("Db parameter group"), parameters: map[string]*string{ "neptune_query_timeout": jsii.String("120000"), }, }) cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &databaseClusterProps{ vpc: vpc, instanceType: neptune.instanceType_R5_LARGE(), clusterParameterGroup: clusterParams, parameterGroup: dbParams, })
Experimental.
type DatabaseCluster ¶
type DatabaseCluster interface { DatabaseClusterBase IDatabaseCluster // The endpoint to use for read/write operations. // Experimental. ClusterEndpoint() Endpoint // Identifier of the cluster. // Experimental. ClusterIdentifier() *string // Endpoint to use for load-balanced read-only operations. // Experimental. ClusterReadEndpoint() Endpoint // The resource id for the cluster; // // for example: cluster-ABCD1234EFGH5678IJKL90MNOP. The cluster ID uniquely // identifies the cluster and is used in things like IAM authentication policies. // Experimental. ClusterResourceIdentifier() *string // The connections object to implement IConnectable. // Experimental. Connections() awsec2.Connections // Experimental. EnableIamAuthentication() *bool // Experimental. SetEnableIamAuthentication(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. // Experimental. Env() *awscdk.ResourceEnvironment // Endpoints which address each individual instance. // Experimental. InstanceEndpoints() *[]Endpoint // Identifiers of the instance. // Experimental. InstanceIdentifiers() *[]*string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string // The stack in which this resource is defined. // Experimental. Stack() awscdk.Stack // Subnet group used by the DB. // Experimental. SubnetGroup() ISubnetGroup // The VPC where the DB subnet group is created. // Experimental. Vpc() awsec2.IVpc // The subnets used by the DB subnet group. // Experimental. VpcSubnets() *awsec2.SubnetSelection // Apply the given removal policy to this resource. // // 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`). // Experimental. ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Experimental. GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. // Experimental. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. // Experimental. GetResourceNameAttribute(nameAttr *string) *string // Grant the given identity connection access to the database. // Experimental. GrantConnect(grantee awsiam.IGrantable) awsiam.Grant // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string }
Create a clustered database with a given number of instances.
Example:
cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &databaseClusterProps{ vpc: vpc, instanceType: neptune.instanceType_R5_LARGE(), instances: jsii.Number(2), })
Experimental.
func NewDatabaseCluster ¶
func NewDatabaseCluster(scope constructs.Construct, id *string, props *DatabaseClusterProps) DatabaseCluster
Experimental.
type DatabaseClusterAttributes ¶
type DatabaseClusterAttributes struct { // Cluster endpoint address. // Experimental. ClusterEndpointAddress *string `field:"required" json:"clusterEndpointAddress" yaml:"clusterEndpointAddress"` // Identifier for the cluster. // Experimental. ClusterIdentifier *string `field:"required" json:"clusterIdentifier" yaml:"clusterIdentifier"` // Resource Identifier for the cluster. // Experimental. ClusterResourceIdentifier *string `field:"required" json:"clusterResourceIdentifier" yaml:"clusterResourceIdentifier"` // The database port. // Experimental. Port *float64 `field:"required" json:"port" yaml:"port"` // Reader endpoint address. // Experimental. ReaderEndpointAddress *string `field:"required" json:"readerEndpointAddress" yaml:"readerEndpointAddress"` // The security group of the database cluster. // Experimental. SecurityGroup awsec2.ISecurityGroup `field:"required" json:"securityGroup" yaml:"securityGroup"` }
Properties that describe an existing cluster instance.
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" import "github.com/aws/aws-cdk-go/awscdk" var securityGroup securityGroup databaseClusterAttributes := &databaseClusterAttributes{ clusterEndpointAddress: jsii.String("clusterEndpointAddress"), clusterIdentifier: jsii.String("clusterIdentifier"), clusterResourceIdentifier: jsii.String("clusterResourceIdentifier"), port: jsii.Number(123), readerEndpointAddress: jsii.String("readerEndpointAddress"), securityGroup: securityGroup, }
Experimental.
type DatabaseClusterBase ¶
type DatabaseClusterBase interface { awscdk.Resource IDatabaseCluster // The endpoint to use for read/write operations. // Experimental. ClusterEndpoint() Endpoint // Identifier of the cluster. // Experimental. ClusterIdentifier() *string // Endpoint to use for load-balanced read-only operations. // Experimental. ClusterReadEndpoint() Endpoint // Resource identifier of the cluster. // Experimental. ClusterResourceIdentifier() *string // The connections object to implement IConnectable. // Experimental. Connections() awsec2.Connections // Experimental. EnableIamAuthentication() *bool // Experimental. SetEnableIamAuthentication(val *bool) // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. // Experimental. Env() *awscdk.ResourceEnvironment // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string // The stack in which this resource is defined. // Experimental. Stack() awscdk.Stack // Apply the given removal policy to this resource. // // 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`). // Experimental. ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Experimental. GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. // Experimental. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. // Experimental. GetResourceNameAttribute(nameAttr *string) *string // Grant the given identity connection access to the database. // Experimental. GrantConnect(grantee awsiam.IGrantable) awsiam.Grant // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string }
A new or imported database cluster.
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" import "github.com/aws/aws-cdk-go/awscdk" var securityGroup securityGroup databaseClusterBase := awscdk.Aws_neptune.databaseClusterBase.fromDatabaseClusterAttributes(this, jsii.String("MyDatabaseClusterBase"), &databaseClusterAttributes{ clusterEndpointAddress: jsii.String("clusterEndpointAddress"), clusterIdentifier: jsii.String("clusterIdentifier"), clusterResourceIdentifier: jsii.String("clusterResourceIdentifier"), port: jsii.Number(123), readerEndpointAddress: jsii.String("readerEndpointAddress"), securityGroup: securityGroup, })
Experimental.
type DatabaseClusterProps ¶
type DatabaseClusterProps struct { // What type of instance to start for the replicas. // Experimental. InstanceType InstanceType `field:"required" json:"instanceType" yaml:"instanceType"` // What subnets to run the Neptune instances in. // // Must be at least 2 subnets in two different AZs. // Experimental. Vpc awsec2.IVpc `field:"required" json:"vpc" yaml:"vpc"` // A list of AWS Identity and Access Management (IAM) role that can be used by the cluster to access other AWS services. // Experimental. AssociatedRoles *[]awsiam.IRole `field:"optional" json:"associatedRoles" yaml:"associatedRoles"` // If set to true, Neptune will automatically update the engine of the entire cluster to the latest minor version after a stabilization window of 2 to 3 weeks. // Experimental. AutoMinorVersionUpgrade *bool `field:"optional" json:"autoMinorVersionUpgrade" yaml:"autoMinorVersionUpgrade"` // How many days to retain the backup. // Experimental. BackupRetention awscdk.Duration `field:"optional" json:"backupRetention" yaml:"backupRetention"` // Additional parameters to pass to the database engine. // Experimental. ClusterParameterGroup IClusterParameterGroup `field:"optional" json:"clusterParameterGroup" yaml:"clusterParameterGroup"` // An optional identifier for the cluster. // Experimental. DbClusterName *string `field:"optional" json:"dbClusterName" yaml:"dbClusterName"` // Indicates whether the DB cluster should have deletion protection enabled. // Experimental. DeletionProtection *bool `field:"optional" json:"deletionProtection" yaml:"deletionProtection"` // What version of the database to start. // Experimental. EngineVersion EngineVersion `field:"optional" json:"engineVersion" yaml:"engineVersion"` // Map AWS Identity and Access Management (IAM) accounts to database accounts. // Experimental. IamAuthentication *bool `field:"optional" json:"iamAuthentication" yaml:"iamAuthentication"` // Base identifier for instances. // // Every replica is named by appending the replica number to this string, 1-based. // Experimental. InstanceIdentifierBase *string `field:"optional" json:"instanceIdentifierBase" yaml:"instanceIdentifierBase"` // Number of Neptune compute instances. // Experimental. Instances *float64 `field:"optional" json:"instances" yaml:"instances"` // The KMS key for storage encryption. // Experimental. KmsKey awskms.IKey `field:"optional" json:"kmsKey" yaml:"kmsKey"` // The DB parameter group to associate with the instance. // Experimental. ParameterGroup IParameterGroup `field:"optional" json:"parameterGroup" yaml:"parameterGroup"` // The port the Neptune cluster will listen on. // Experimental. Port *float64 `field:"optional" json:"port" yaml:"port"` // A daily time range in 24-hours UTC format in which backups preferably execute. // // Must be at least 30 minutes long. // // Example: '01:00-02:00'. // Experimental. PreferredBackupWindow *string `field:"optional" json:"preferredBackupWindow" yaml:"preferredBackupWindow"` // A weekly time range in which maintenance should preferably execute. // // Must be at least 30 minutes long. // // Example: 'tue:04:17-tue:04:47'. // Experimental. PreferredMaintenanceWindow *string `field:"optional" json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"` // The removal policy to apply when the cluster and its instances are removed or replaced during a stack update, or when the stack is deleted. // // This // removal policy also applies to the implicit security group created for the // cluster if one is not supplied as a parameter. // Experimental. RemovalPolicy awscdk.RemovalPolicy `field:"optional" json:"removalPolicy" yaml:"removalPolicy"` // Security group. // Experimental. SecurityGroups *[]awsec2.ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"` // Whether to enable storage encryption. // Experimental. StorageEncrypted *bool `field:"optional" json:"storageEncrypted" yaml:"storageEncrypted"` // Existing subnet group for the cluster. // Experimental. SubnetGroup ISubnetGroup `field:"optional" json:"subnetGroup" yaml:"subnetGroup"` // Where to place the instances within the VPC. // Experimental. VpcSubnets *awsec2.SubnetSelection `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"` }
Properties for a new database cluster.
Example:
cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &databaseClusterProps{ vpc: vpc, instanceType: neptune.instanceType_R5_LARGE(), instances: jsii.Number(2), })
Experimental.
type DatabaseInstance ¶
type DatabaseInstance interface { awscdk.Resource IDatabaseInstance // The instance's database cluster. // Experimental. Cluster() IDatabaseCluster // The instance endpoint address. // Experimental. DbInstanceEndpointAddress() *string // The instance endpoint port. // Experimental. DbInstanceEndpointPort() *string // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. // Experimental. Env() *awscdk.ResourceEnvironment // The instance endpoint. // Experimental. InstanceEndpoint() Endpoint // The instance identifier. // Experimental. InstanceIdentifier() *string // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string // The stack in which this resource is defined. // Experimental. Stack() awscdk.Stack // Apply the given removal policy to this resource. // // 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`). // Experimental. ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Experimental. GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. // Experimental. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. // Experimental. GetResourceNameAttribute(nameAttr *string) *string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string }
A database instance.
Example:
replica1 := neptune.NewDatabaseInstance(this, jsii.String("Instance"), &databaseInstanceProps{ cluster: cluster, instanceType: neptune.*instanceType_R5_LARGE(), })
Experimental.
func NewDatabaseInstance ¶
func NewDatabaseInstance(scope constructs.Construct, id *string, props *DatabaseInstanceProps) DatabaseInstance
Experimental.
type DatabaseInstanceAttributes ¶
type DatabaseInstanceAttributes struct { // The endpoint address. // Experimental. InstanceEndpointAddress *string `field:"required" json:"instanceEndpointAddress" yaml:"instanceEndpointAddress"` // The instance identifier. // Experimental. InstanceIdentifier *string `field:"required" json:"instanceIdentifier" yaml:"instanceIdentifier"` // The database port. // Experimental. Port *float64 `field:"required" json:"port" yaml:"port"` }
Properties that describe an existing instance.
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" databaseInstanceAttributes := &databaseInstanceAttributes{ instanceEndpointAddress: jsii.String("instanceEndpointAddress"), instanceIdentifier: jsii.String("instanceIdentifier"), port: jsii.Number(123), }
Experimental.
type DatabaseInstanceProps ¶
type DatabaseInstanceProps struct { // The Neptune database cluster the instance should launch into. // Experimental. Cluster IDatabaseCluster `field:"required" json:"cluster" yaml:"cluster"` // What type of instance to start for the replicas. // Experimental. InstanceType InstanceType `field:"required" json:"instanceType" yaml:"instanceType"` // The name of the Availability Zone where the DB instance will be located. // Experimental. AvailabilityZone *string `field:"optional" json:"availabilityZone" yaml:"availabilityZone"` // A name for the DB instance. // // If you specify a name, AWS CloudFormation // converts it to lowercase. // Experimental. DbInstanceName *string `field:"optional" json:"dbInstanceName" yaml:"dbInstanceName"` // The DB parameter group to associate with the instance. // Experimental. ParameterGroup IParameterGroup `field:"optional" json:"parameterGroup" yaml:"parameterGroup"` // The CloudFormation policy to apply when the instance is removed from the stack or replaced during an update. // Experimental. RemovalPolicy awscdk.RemovalPolicy `field:"optional" json:"removalPolicy" yaml:"removalPolicy"` }
Construction properties for a DatabaseInstanceNew.
Example:
replica1 := neptune.NewDatabaseInstance(this, jsii.String("Instance"), &databaseInstanceProps{ cluster: cluster, instanceType: neptune.*instanceType_R5_LARGE(), })
Experimental.
type Endpoint ¶
type Endpoint interface { // The hostname of the endpoint. // Experimental. Hostname() *string // The port of the endpoint. // Experimental. Port() *float64 // The combination of "HOSTNAME:PORT" for this endpoint. // Experimental. SocketAddress() *string }
Connection endpoint of a neptune cluster or instance.
Consists of a combination of hostname and port.
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" endpoint := awscdk.Aws_neptune.NewEndpoint(jsii.String("address"), jsii.Number(123))
Experimental.
type EngineVersion ¶
type EngineVersion interface { // the engine version of Neptune. // Experimental. Version() *string }
Possible Instances Types to use in Neptune cluster used for defining {@link DatabaseClusterProps.engineVersion}.
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" engineVersion := awscdk.Aws_neptune.engineVersion_V1_0_1_0()
Experimental.
func EngineVersion_V1_0_1_0 ¶
func EngineVersion_V1_0_1_0() EngineVersion
func EngineVersion_V1_0_1_1 ¶
func EngineVersion_V1_0_1_1() EngineVersion
func EngineVersion_V1_0_1_2 ¶
func EngineVersion_V1_0_1_2() EngineVersion
func EngineVersion_V1_0_2_1 ¶
func EngineVersion_V1_0_2_1() EngineVersion
func EngineVersion_V1_0_2_2 ¶
func EngineVersion_V1_0_2_2() EngineVersion
func EngineVersion_V1_0_3_0 ¶
func EngineVersion_V1_0_3_0() EngineVersion
func EngineVersion_V1_0_4_0 ¶
func EngineVersion_V1_0_4_0() EngineVersion
func EngineVersion_V1_0_4_1 ¶
func EngineVersion_V1_0_4_1() EngineVersion
func EngineVersion_V1_0_5_0 ¶
func EngineVersion_V1_0_5_0() EngineVersion
func EngineVersion_V1_1_0_0 ¶
func EngineVersion_V1_1_0_0() EngineVersion
func NewEngineVersion ¶
func NewEngineVersion(version *string) EngineVersion
Constructor for specifying a custom engine version. Experimental.
type IClusterParameterGroup ¶
type IClusterParameterGroup interface { awscdk.IResource // The name of this parameter group. // Experimental. ClusterParameterGroupName() *string }
A parameter group. Experimental.
func ClusterParameterGroup_FromClusterParameterGroupName ¶
func ClusterParameterGroup_FromClusterParameterGroupName(scope constructs.Construct, id *string, clusterParameterGroupName *string) IClusterParameterGroup
Imports a parameter group. Experimental.
type IDatabaseCluster ¶
type IDatabaseCluster interface { awsec2.IConnectable awscdk.IResource // Grant the given identity connection access to the database. // Experimental. GrantConnect(grantee awsiam.IGrantable) awsiam.Grant // The endpoint to use for read/write operations. // Experimental. ClusterEndpoint() Endpoint // Identifier of the cluster. // Experimental. ClusterIdentifier() *string // Endpoint to use for load-balanced read-only operations. // Experimental. ClusterReadEndpoint() Endpoint // Resource identifier of the cluster. // Experimental. ClusterResourceIdentifier() *string }
Create a clustered database with a given number of instances. Experimental.
func DatabaseClusterBase_FromDatabaseClusterAttributes ¶
func DatabaseClusterBase_FromDatabaseClusterAttributes(scope constructs.Construct, id *string, attrs *DatabaseClusterAttributes) IDatabaseCluster
Import an existing DatabaseCluster from properties. Experimental.
func DatabaseCluster_FromDatabaseClusterAttributes ¶
func DatabaseCluster_FromDatabaseClusterAttributes(scope constructs.Construct, id *string, attrs *DatabaseClusterAttributes) IDatabaseCluster
Import an existing DatabaseCluster from properties. Experimental.
type IDatabaseInstance ¶
type IDatabaseInstance interface { awscdk.IResource // The instance endpoint address. // Experimental. DbInstanceEndpointAddress() *string // The instance endpoint port. // Experimental. DbInstanceEndpointPort() *string // The instance endpoint. // Experimental. InstanceEndpoint() Endpoint // The instance identifier. // Experimental. InstanceIdentifier() *string }
A database instance. Experimental.
func DatabaseInstance_FromDatabaseInstanceAttributes ¶
func DatabaseInstance_FromDatabaseInstanceAttributes(scope constructs.Construct, id *string, attrs *DatabaseInstanceAttributes) IDatabaseInstance
Import an existing database instance. Experimental.
type IParameterGroup ¶
type IParameterGroup interface { awscdk.IResource // The name of this parameter group. // Experimental. ParameterGroupName() *string }
A parameter group. Experimental.
func ParameterGroup_FromParameterGroupName ¶
func ParameterGroup_FromParameterGroupName(scope constructs.Construct, id *string, parameterGroupName *string) IParameterGroup
Imports a parameter group. Experimental.
type ISubnetGroup ¶
type ISubnetGroup interface { awscdk.IResource // The name of the subnet group. // Experimental. SubnetGroupName() *string }
Interface for a subnet group. Experimental.
func SubnetGroup_FromSubnetGroupName ¶
func SubnetGroup_FromSubnetGroupName(scope constructs.Construct, id *string, subnetGroupName *string) ISubnetGroup
Imports an existing subnet group by name. Experimental.
type InstanceType ¶
type InstanceType interface { }
Possible Instances Types to use in Neptune cluster used for defining {@link DatabaseInstanceProps.instanceType}.
Example:
cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &databaseClusterProps{ vpc: vpc, instanceType: neptune.instanceType_R5_LARGE(), instances: jsii.Number(2), })
Experimental.
func InstanceType_Of ¶
func InstanceType_Of(instanceType *string) InstanceType
Build an InstanceType from given string or token, such as CfnParameter. Experimental.
func InstanceType_R4_2XLARGE ¶
func InstanceType_R4_2XLARGE() InstanceType
func InstanceType_R4_4XLARGE ¶
func InstanceType_R4_4XLARGE() InstanceType
func InstanceType_R4_8XLARGE ¶
func InstanceType_R4_8XLARGE() InstanceType
func InstanceType_R4_LARGE ¶
func InstanceType_R4_LARGE() InstanceType
func InstanceType_R4_XLARGE ¶
func InstanceType_R4_XLARGE() InstanceType
func InstanceType_R5_12XLARGE ¶
func InstanceType_R5_12XLARGE() InstanceType
func InstanceType_R5_24XLARGE ¶
func InstanceType_R5_24XLARGE() InstanceType
func InstanceType_R5_2XLARGE ¶
func InstanceType_R5_2XLARGE() InstanceType
func InstanceType_R5_4XLARGE ¶
func InstanceType_R5_4XLARGE() InstanceType
func InstanceType_R5_8XLARGE ¶
func InstanceType_R5_8XLARGE() InstanceType
func InstanceType_R5_LARGE ¶
func InstanceType_R5_LARGE() InstanceType
func InstanceType_R5_XLARGE ¶
func InstanceType_R5_XLARGE() InstanceType
func InstanceType_R6G_12XLARGE ¶
func InstanceType_R6G_12XLARGE() InstanceType
func InstanceType_R6G_16XLARGE ¶
func InstanceType_R6G_16XLARGE() InstanceType
func InstanceType_R6G_2XLARGE ¶
func InstanceType_R6G_2XLARGE() InstanceType
func InstanceType_R6G_4XLARGE ¶
func InstanceType_R6G_4XLARGE() InstanceType
func InstanceType_R6G_8XLARGE ¶
func InstanceType_R6G_8XLARGE() InstanceType
func InstanceType_R6G_LARGE ¶
func InstanceType_R6G_LARGE() InstanceType
func InstanceType_R6G_XLARGE ¶
func InstanceType_R6G_XLARGE() InstanceType
func InstanceType_T3_MEDIUM ¶
func InstanceType_T3_MEDIUM() InstanceType
func InstanceType_T4G_MEDIUM ¶
func InstanceType_T4G_MEDIUM() InstanceType
type ParameterGroup ¶
type ParameterGroup interface { awscdk.Resource IParameterGroup // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. // Experimental. Env() *awscdk.ResourceEnvironment // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // The name of the parameter group. // Experimental. ParameterGroupName() *string // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string // The stack in which this resource is defined. // Experimental. Stack() awscdk.Stack // Apply the given removal policy to this resource. // // 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`). // Experimental. ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Experimental. GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. // Experimental. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. // Experimental. GetResourceNameAttribute(nameAttr *string) *string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string }
DB parameter group.
Example:
clusterParams := neptune.NewClusterParameterGroup(this, jsii.String("ClusterParams"), &clusterParameterGroupProps{ description: jsii.String("Cluster parameter group"), parameters: map[string]*string{ "neptune_enable_audit_log": jsii.String("1"), }, }) dbParams := neptune.NewParameterGroup(this, jsii.String("DbParams"), ¶meterGroupProps{ description: jsii.String("Db parameter group"), parameters: map[string]*string{ "neptune_query_timeout": jsii.String("120000"), }, }) cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &databaseClusterProps{ vpc: vpc, instanceType: neptune.instanceType_R5_LARGE(), clusterParameterGroup: clusterParams, parameterGroup: dbParams, })
Experimental.
func NewParameterGroup ¶
func NewParameterGroup(scope constructs.Construct, id *string, props *ParameterGroupProps) ParameterGroup
Experimental.
type ParameterGroupProps ¶
type ParameterGroupProps struct { // The parameters in this parameter group. // Experimental. Parameters *map[string]*string `field:"required" json:"parameters" yaml:"parameters"` // Description for this parameter group. // Experimental. Description *string `field:"optional" json:"description" yaml:"description"` // The name of the parameter group. // Experimental. ParameterGroupName *string `field:"optional" json:"parameterGroupName" yaml:"parameterGroupName"` }
Marker class for cluster parameter group.
Example:
clusterParams := neptune.NewClusterParameterGroup(this, jsii.String("ClusterParams"), &clusterParameterGroupProps{ description: jsii.String("Cluster parameter group"), parameters: map[string]*string{ "neptune_enable_audit_log": jsii.String("1"), }, }) dbParams := neptune.NewParameterGroup(this, jsii.String("DbParams"), ¶meterGroupProps{ description: jsii.String("Db parameter group"), parameters: map[string]*string{ "neptune_query_timeout": jsii.String("120000"), }, }) cluster := neptune.NewDatabaseCluster(this, jsii.String("Database"), &databaseClusterProps{ vpc: vpc, instanceType: neptune.instanceType_R5_LARGE(), clusterParameterGroup: clusterParams, parameterGroup: dbParams, })
Experimental.
type SubnetGroup ¶
type SubnetGroup interface { awscdk.Resource ISubnetGroup // The environment this resource belongs to. // // For resources that are created and managed by the CDK // (generally, those created by creating new class instances like Role, Bucket, etc.), // this is always the same as the environment of the stack they belong to; // however, for imported resources // (those obtained from static methods like fromRoleArn, fromBucketName, etc.), // that might be different than the stack they were imported into. // Experimental. Env() *awscdk.ResourceEnvironment // The construct tree node associated with this construct. // Experimental. Node() awscdk.ConstructNode // Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource. // // This value will resolve to one of the following: // - a concrete value (e.g. `"my-awesome-bucket"`) // - `undefined`, when a name should be generated by CloudFormation // - a concrete name generated automatically during synthesis, in // cross-environment scenarios. // Experimental. PhysicalName() *string // The stack in which this resource is defined. // Experimental. Stack() awscdk.Stack // The name of the subnet group. // Experimental. SubnetGroupName() *string // Apply the given removal policy to this resource. // // 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`). // Experimental. ApplyRemovalPolicy(policy awscdk.RemovalPolicy) // Experimental. GeneratePhysicalName() *string // Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`). // // Normally, this token will resolve to `arnAttr`, but if the resource is // referenced across environments, `arnComponents` will be used to synthesize // a concrete ARN with the resource's physical name. Make sure to reference // `this.physicalName` in `arnComponents`. // Experimental. GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string // Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`). // // Normally, this token will resolve to `nameAttr`, but if the resource is // referenced across environments, it will be resolved to `this.physicalName`, // which will be a concrete name. // Experimental. GetResourceNameAttribute(nameAttr *string) *string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. OnPrepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. OnSynthesize(session constructs.ISynthesisSession) // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. OnValidate() *[]*string // Perform final modifications before synthesis. // // This method can be implemented by derived constructs in order to perform // final changes before synthesis. prepare() will be called after child // constructs have been prepared. // // This is an advanced framework feature. Only use this if you // understand the implications. // Experimental. Prepare() // Allows this construct to emit artifacts into the cloud assembly during synthesis. // // This method is usually implemented by framework-level constructs such as `Stack` and `Asset` // as they participate in synthesizing the cloud assembly. // Experimental. Synthesize(session awscdk.ISynthesisSession) // Returns a string representation of this construct. // Experimental. ToString() *string // Validate the current construct. // // This method can be implemented by derived constructs in order to perform // validation logic. It is called on all constructs before synthesis. // // Returns: An array of validation error messages, or an empty array if the construct is valid. // Experimental. Validate() *[]*string }
Class for creating a RDS DB subnet group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import monocdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" var subnet subnet var subnetFilter subnetFilter var vpc vpc subnetGroup := awscdk.Aws_neptune.NewSubnetGroup(this, jsii.String("MySubnetGroup"), &subnetGroupProps{ vpc: vpc, // the properties below are optional description: jsii.String("description"), removalPolicy: monocdk.removalPolicy_DESTROY, subnetGroupName: jsii.String("subnetGroupName"), vpcSubnets: &subnetSelection{ availabilityZones: []*string{ jsii.String("availabilityZones"), }, onePerAz: jsii.Boolean(false), subnetFilters: []*subnetFilter{ subnetFilter, }, subnetGroupName: jsii.String("subnetGroupName"), subnetName: jsii.String("subnetName"), subnets: []iSubnet{ subnet, }, subnetType: awscdk.Aws_ec2.subnetType_ISOLATED, }, })
Experimental.
func NewSubnetGroup ¶
func NewSubnetGroup(scope constructs.Construct, id *string, props *SubnetGroupProps) SubnetGroup
Experimental.
type SubnetGroupProps ¶
type SubnetGroupProps struct { // The VPC to place the subnet group in. // Experimental. Vpc awsec2.IVpc `field:"required" json:"vpc" yaml:"vpc"` // Description of the subnet group. // Experimental. Description *string `field:"optional" json:"description" yaml:"description"` // The removal policy to apply when the subnet group are removed from the stack or replaced during an update. // Experimental. RemovalPolicy awscdk.RemovalPolicy `field:"optional" json:"removalPolicy" yaml:"removalPolicy"` // The name of the subnet group. // Experimental. SubnetGroupName *string `field:"optional" json:"subnetGroupName" yaml:"subnetGroupName"` // Which subnets within the VPC to associate with this group. // Experimental. VpcSubnets *awsec2.SubnetSelection `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"` }
Properties for creating a SubnetGroup.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import monocdk "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" import "github.com/aws/aws-cdk-go/awscdk" var subnet subnet var subnetFilter subnetFilter var vpc vpc subnetGroupProps := &subnetGroupProps{ vpc: vpc, // the properties below are optional description: jsii.String("description"), removalPolicy: monocdk.removalPolicy_DESTROY, subnetGroupName: jsii.String("subnetGroupName"), vpcSubnets: &subnetSelection{ availabilityZones: []*string{ jsii.String("availabilityZones"), }, onePerAz: jsii.Boolean(false), subnetFilters: []*subnetFilter{ subnetFilter, }, subnetGroupName: jsii.String("subnetGroupName"), subnetName: jsii.String("subnetName"), subnets: []iSubnet{ subnet, }, subnetType: awscdk.Aws_ec2.subnetType_ISOLATED, }, }
Experimental.
Source Files ¶
- awsneptune.go
- awsneptune_CfnDBCluster.go
- awsneptune_CfnDBClusterParameterGroup.go
- awsneptune_CfnDBClusterParameterGroupProps.go
- awsneptune_CfnDBClusterParameterGroup__runtime_type_checks.go
- awsneptune_CfnDBClusterProps.go
- awsneptune_CfnDBCluster_DBClusterRoleProperty.go
- awsneptune_CfnDBCluster__runtime_type_checks.go
- awsneptune_CfnDBInstance.go
- awsneptune_CfnDBInstanceProps.go
- awsneptune_CfnDBInstance__runtime_type_checks.go
- awsneptune_CfnDBParameterGroup.go
- awsneptune_CfnDBParameterGroupProps.go
- awsneptune_CfnDBParameterGroup__runtime_type_checks.go
- awsneptune_CfnDBSubnetGroup.go
- awsneptune_CfnDBSubnetGroupProps.go
- awsneptune_CfnDBSubnetGroup__runtime_type_checks.go
- awsneptune_ClusterParameterGroup.go
- awsneptune_ClusterParameterGroupProps.go
- awsneptune_ClusterParameterGroup__runtime_type_checks.go
- awsneptune_DatabaseCluster.go
- awsneptune_DatabaseClusterAttributes.go
- awsneptune_DatabaseClusterBase.go
- awsneptune_DatabaseClusterBase__runtime_type_checks.go
- awsneptune_DatabaseClusterProps.go
- awsneptune_DatabaseCluster__runtime_type_checks.go
- awsneptune_DatabaseInstance.go
- awsneptune_DatabaseInstanceAttributes.go
- awsneptune_DatabaseInstanceProps.go
- awsneptune_DatabaseInstance__runtime_type_checks.go
- awsneptune_Endpoint.go
- awsneptune_Endpoint__runtime_type_checks.go
- awsneptune_EngineVersion.go
- awsneptune_EngineVersion__runtime_type_checks.go
- awsneptune_IClusterParameterGroup.go
- awsneptune_IDatabaseCluster.go
- awsneptune_IDatabaseCluster__runtime_type_checks.go
- awsneptune_IDatabaseInstance.go
- awsneptune_IParameterGroup.go
- awsneptune_ISubnetGroup.go
- awsneptune_InstanceType.go
- awsneptune_InstanceType__runtime_type_checks.go
- awsneptune_ParameterGroup.go
- awsneptune_ParameterGroupProps.go
- awsneptune_ParameterGroup__runtime_type_checks.go
- awsneptune_SubnetGroup.go
- awsneptune_SubnetGroupProps.go
- awsneptune_SubnetGroup__runtime_type_checks.go