Documentation
¶
Index ¶
- func CfnACL_ArnForACL(resource interfacesawsmemorydb.IACLRef) *string
- func CfnACL_CFN_RESOURCE_TYPE_NAME() *string
- func CfnACL_FromACLArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.IACLRef
- func CfnACL_FromAclName(scope constructs.Construct, id *string, aclName *string) interfacesawsmemorydb.IACLRef
- func CfnACL_IsCfnACL(x interface{}) *bool
- func CfnACL_IsCfnElement(x interface{}) *bool
- func CfnACL_IsCfnResource(x interface{}) *bool
- func CfnACL_IsConstruct(x interface{}) *bool
- func CfnCluster_ArnForCluster(resource interfacesawsmemorydb.IClusterRef) *string
- func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCluster_FromClusterArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.IClusterRef
- func CfnCluster_FromClusterName(scope constructs.Construct, id *string, clusterName *string) interfacesawsmemorydb.IClusterRef
- func CfnCluster_IsCfnCluster(x interface{}) *bool
- func CfnCluster_IsCfnElement(x interface{}) *bool
- func CfnCluster_IsCfnResource(x interface{}) *bool
- func CfnCluster_IsConstruct(x interface{}) *bool
- func CfnMultiRegionCluster_ArnForMultiRegionCluster(resource interfacesawsmemorydb.IMultiRegionClusterRef) *string
- func CfnMultiRegionCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMultiRegionCluster_IsCfnElement(x interface{}) *bool
- func CfnMultiRegionCluster_IsCfnMultiRegionCluster(x interface{}) *bool
- func CfnMultiRegionCluster_IsCfnResource(x interface{}) *bool
- func CfnMultiRegionCluster_IsConstruct(x interface{}) *bool
- func CfnParameterGroup_ArnForParameterGroup(resource interfacesawsmemorydb.IParameterGroupRef) *string
- func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnParameterGroup_FromParameterGroupArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.IParameterGroupRef
- func CfnParameterGroup_FromParameterGroupName(scope constructs.Construct, id *string, parameterGroupName *string) interfacesawsmemorydb.IParameterGroupRef
- func CfnParameterGroup_IsCfnElement(x interface{}) *bool
- func CfnParameterGroup_IsCfnParameterGroup(x interface{}) *bool
- func CfnParameterGroup_IsCfnResource(x interface{}) *bool
- func CfnParameterGroup_IsConstruct(x interface{}) *bool
- func CfnSubnetGroup_ArnForSubnetGroup(resource interfacesawsmemorydb.ISubnetGroupRef) *string
- func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubnetGroup_FromSubnetGroupArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.ISubnetGroupRef
- func CfnSubnetGroup_FromSubnetGroupName(scope constructs.Construct, id *string, subnetGroupName *string) interfacesawsmemorydb.ISubnetGroupRef
- func CfnSubnetGroup_IsCfnElement(x interface{}) *bool
- func CfnSubnetGroup_IsCfnResource(x interface{}) *bool
- func CfnSubnetGroup_IsCfnSubnetGroup(x interface{}) *bool
- func CfnSubnetGroup_IsConstruct(x interface{}) *bool
- func CfnUser_ArnForUser(resource interfacesawsmemorydb.IUserRef) *string
- func CfnUser_CFN_RESOURCE_TYPE_NAME() *string
- func CfnUser_FromUserArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.IUserRef
- func CfnUser_FromUserName(scope constructs.Construct, id *string, userName *string) interfacesawsmemorydb.IUserRef
- func CfnUser_IsCfnElement(x interface{}) *bool
- func CfnUser_IsCfnResource(x interface{}) *bool
- func CfnUser_IsCfnUser(x interface{}) *bool
- func CfnUser_IsConstruct(x interface{}) *bool
- func NewCfnACL_Override(c CfnACL, scope constructs.Construct, id *string, props *CfnACLProps)
- func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
- func NewCfnMultiRegionCluster_Override(c CfnMultiRegionCluster, scope constructs.Construct, id *string, ...)
- func NewCfnParameterGroup_Override(c CfnParameterGroup, scope constructs.Construct, id *string, ...)
- func NewCfnSubnetGroup_Override(c CfnSubnetGroup, scope constructs.Construct, id *string, ...)
- func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)
- type CfnACL
- type CfnACLProps
- type CfnCluster
- type CfnClusterProps
- type CfnCluster_EndpointProperty
- type CfnMultiRegionCluster
- type CfnMultiRegionClusterProps
- type CfnParameterGroup
- type CfnParameterGroupProps
- type CfnSubnetGroup
- type CfnSubnetGroupProps
- type CfnUser
- type CfnUserProps
- type CfnUser_AuthenticationModeProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnACL_ArnForACL ¶ added in v2.227.0
func CfnACL_ArnForACL(resource interfacesawsmemorydb.IACLRef) *string
func CfnACL_CFN_RESOURCE_TYPE_NAME ¶
func CfnACL_CFN_RESOURCE_TYPE_NAME() *string
func CfnACL_FromACLArn ¶ added in v2.218.0
func CfnACL_FromACLArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.IACLRef
Creates a new IACLRef from an ARN.
func CfnACL_FromAclName ¶ added in v2.218.0
func CfnACL_FromAclName(scope constructs.Construct, id *string, aclName *string) interfacesawsmemorydb.IACLRef
Creates a new IACLRef from a aclName.
func CfnACL_IsCfnACL ¶ added in v2.231.0
func CfnACL_IsCfnACL(x interface{}) *bool
Checks whether the given object is a CfnACL.
func CfnACL_IsCfnElement ¶
func CfnACL_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnACL_IsCfnResource ¶
func CfnACL_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnACL_IsConstruct ¶
func CfnACL_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnCluster_ArnForCluster ¶ added in v2.227.0
func CfnCluster_ArnForCluster(resource interfacesawsmemorydb.IClusterRef) *string
func CfnCluster_CFN_RESOURCE_TYPE_NAME ¶
func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnCluster_FromClusterArn ¶ added in v2.231.0
func CfnCluster_FromClusterArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.IClusterRef
Creates a new IClusterRef from an ARN.
func CfnCluster_FromClusterName ¶ added in v2.218.0
func CfnCluster_FromClusterName(scope constructs.Construct, id *string, clusterName *string) interfacesawsmemorydb.IClusterRef
Creates a new IClusterRef from a clusterName.
func CfnCluster_IsCfnCluster ¶ added in v2.231.0
func CfnCluster_IsCfnCluster(x interface{}) *bool
Checks whether the given object is a CfnCluster.
func CfnCluster_IsCfnElement ¶
func CfnCluster_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnCluster_IsCfnResource ¶
func CfnCluster_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnCluster_IsConstruct ¶
func CfnCluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMultiRegionCluster_ArnForMultiRegionCluster ¶ added in v2.231.0
func CfnMultiRegionCluster_ArnForMultiRegionCluster(resource interfacesawsmemorydb.IMultiRegionClusterRef) *string
func CfnMultiRegionCluster_CFN_RESOURCE_TYPE_NAME ¶ added in v2.173.0
func CfnMultiRegionCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnMultiRegionCluster_IsCfnElement ¶ added in v2.173.0
func CfnMultiRegionCluster_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnMultiRegionCluster_IsCfnMultiRegionCluster ¶ added in v2.231.0
func CfnMultiRegionCluster_IsCfnMultiRegionCluster(x interface{}) *bool
Checks whether the given object is a CfnMultiRegionCluster.
func CfnMultiRegionCluster_IsCfnResource ¶ added in v2.173.0
func CfnMultiRegionCluster_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMultiRegionCluster_IsConstruct ¶ added in v2.173.0
func CfnMultiRegionCluster_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnParameterGroup_ArnForParameterGroup ¶ added in v2.227.0
func CfnParameterGroup_ArnForParameterGroup(resource interfacesawsmemorydb.IParameterGroupRef) *string
func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnParameterGroup_FromParameterGroupArn ¶ added in v2.231.0
func CfnParameterGroup_FromParameterGroupArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.IParameterGroupRef
Creates a new IParameterGroupRef from an ARN.
func CfnParameterGroup_FromParameterGroupName ¶ added in v2.218.0
func CfnParameterGroup_FromParameterGroupName(scope constructs.Construct, id *string, parameterGroupName *string) interfacesawsmemorydb.IParameterGroupRef
Creates a new IParameterGroupRef from a parameterGroupName.
func CfnParameterGroup_IsCfnElement ¶
func CfnParameterGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnParameterGroup_IsCfnParameterGroup ¶ added in v2.231.0
func CfnParameterGroup_IsCfnParameterGroup(x interface{}) *bool
Checks whether the given object is a CfnParameterGroup.
func CfnParameterGroup_IsCfnResource ¶
func CfnParameterGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnParameterGroup_IsConstruct ¶
func CfnParameterGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSubnetGroup_ArnForSubnetGroup ¶ added in v2.227.0
func CfnSubnetGroup_ArnForSubnetGroup(resource interfacesawsmemorydb.ISubnetGroupRef) *string
func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnSubnetGroup_FromSubnetGroupArn ¶ added in v2.231.0
func CfnSubnetGroup_FromSubnetGroupArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.ISubnetGroupRef
Creates a new ISubnetGroupRef from an ARN.
func CfnSubnetGroup_FromSubnetGroupName ¶ added in v2.218.0
func CfnSubnetGroup_FromSubnetGroupName(scope constructs.Construct, id *string, subnetGroupName *string) interfacesawsmemorydb.ISubnetGroupRef
Creates a new ISubnetGroupRef from a subnetGroupName.
func CfnSubnetGroup_IsCfnElement ¶
func CfnSubnetGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnSubnetGroup_IsCfnResource ¶
func CfnSubnetGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSubnetGroup_IsCfnSubnetGroup ¶ added in v2.231.0
func CfnSubnetGroup_IsCfnSubnetGroup(x interface{}) *bool
Checks whether the given object is a CfnSubnetGroup.
func CfnSubnetGroup_IsConstruct ¶
func CfnSubnetGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnUser_ArnForUser ¶ added in v2.227.0
func CfnUser_ArnForUser(resource interfacesawsmemorydb.IUserRef) *string
func CfnUser_CFN_RESOURCE_TYPE_NAME ¶
func CfnUser_CFN_RESOURCE_TYPE_NAME() *string
func CfnUser_FromUserArn ¶ added in v2.218.0
func CfnUser_FromUserArn(scope constructs.Construct, id *string, arn *string) interfacesawsmemorydb.IUserRef
Creates a new IUserRef from an ARN.
func CfnUser_FromUserName ¶ added in v2.218.0
func CfnUser_FromUserName(scope constructs.Construct, id *string, userName *string) interfacesawsmemorydb.IUserRef
Creates a new IUserRef from a userName.
func CfnUser_IsCfnElement ¶
func CfnUser_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnUser_IsCfnResource ¶
func CfnUser_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnUser_IsCfnUser ¶ added in v2.231.0
func CfnUser_IsCfnUser(x interface{}) *bool
Checks whether the given object is a CfnUser.
func CfnUser_IsConstruct ¶
func CfnUser_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnACL_Override ¶
func NewCfnACL_Override(c CfnACL, scope constructs.Construct, id *string, props *CfnACLProps)
Create a new `AWS::MemoryDB::ACL`.
func NewCfnCluster_Override ¶
func NewCfnCluster_Override(c CfnCluster, scope constructs.Construct, id *string, props *CfnClusterProps)
Create a new `AWS::MemoryDB::Cluster`.
func NewCfnMultiRegionCluster_Override ¶ added in v2.173.0
func NewCfnMultiRegionCluster_Override(c CfnMultiRegionCluster, scope constructs.Construct, id *string, props *CfnMultiRegionClusterProps)
Create a new `AWS::MemoryDB::MultiRegionCluster`.
func NewCfnParameterGroup_Override ¶
func NewCfnParameterGroup_Override(c CfnParameterGroup, scope constructs.Construct, id *string, props *CfnParameterGroupProps)
Create a new `AWS::MemoryDB::ParameterGroup`.
func NewCfnSubnetGroup_Override ¶
func NewCfnSubnetGroup_Override(c CfnSubnetGroup, scope constructs.Construct, id *string, props *CfnSubnetGroupProps)
Create a new `AWS::MemoryDB::SubnetGroup`.
func NewCfnUser_Override ¶
func NewCfnUser_Override(c CfnUser, scope constructs.Construct, id *string, props *CfnUserProps)
Create a new `AWS::MemoryDB::User`.
Types ¶
type CfnACL ¶
type CfnACL interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsmemorydb.IACLRef
awscdk.ITaggable
// The name of the Access Control List.
AclName() *string
SetAclName(val *string)
// A reference to a ACL resource.
AclRef() *interfacesawsmemorydb.ACLReference
// When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the Access Control List, such as `arn:aws:memorydb:us-east-1:123456789012:acl/my-acl`.
AttrArn() *string
// Indicates ACL status.
//
// *Valid values* : `creating` | `active` | `modifying` | `deleting`.
AttrStatus() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The list of users that belong to the Access Control List.
UserNames() *[]*string
SetUserNames(val *[]*string)
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Specifies an Access Control List.
For more information, see [Authenticating users with Access Contol Lists (ACLs)](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) .
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"
cfnACL := awscdk.Aws_memorydb.NewCfnACL(this, jsii.String("MyCfnACL"), &CfnACLProps{
AclName: jsii.String("aclName"),
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UserNames: []*string{
jsii.String("userNames"),
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html
func NewCfnACL ¶
func NewCfnACL(scope constructs.Construct, id *string, props *CfnACLProps) CfnACL
Create a new `AWS::MemoryDB::ACL`.
type CfnACLProps ¶
type CfnACLProps struct {
// The name of the Access Control List.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html#cfn-memorydb-acl-aclname
//
AclName *string `field:"required" json:"aclName" yaml:"aclName"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html#cfn-memorydb-acl-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// The list of users that belong to the Access Control List.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html#cfn-memorydb-acl-usernames
//
UserNames *[]*string `field:"optional" json:"userNames" yaml:"userNames"`
}
Properties for defining a `CfnACL`.
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"
cfnACLProps := &CfnACLProps{
AclName: jsii.String("aclName"),
// the properties below are optional
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
UserNames: []*string{
jsii.String("userNames"),
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-acl.html
type CfnCluster ¶
type CfnCluster interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsmemorydb.IClusterRef
awscdk.ITaggable
// The name of the Access Control List to associate with the cluster .
AclName() *string
SetAclName(val *string)
// When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the cluster , such as `arn:aws:memorydb:us-east-1:123456789012:cluster/my-cluster`.
AttrArn() *string
// The address of the cluster 's configuration endpoint.
AttrClusterEndpointAddress() *string
// The port used by the cluster configuration endpoint.
AttrClusterEndpointPort() *float64
// The status of the parameter group used by the cluster , for example `active` or `applying` .
AttrParameterGroupStatus() *string
// The status of the cluster.
//
// For example, 'available', 'updating' or 'creating'.
AttrStatus() *string
// When set to true, the cluster will automatically receive minor engine version upgrades after launch.
AutoMinorVersionUpgrade() interface{}
SetAutoMinorVersionUpgrade(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// The cluster 's configuration endpoint.
ClusterEndpoint() interface{}
SetClusterEndpoint(val interface{})
// The name of the cluster .
ClusterName() *string
SetClusterName(val *string)
// A reference to a Cluster resource.
ClusterRef() *interfacesawsmemorydb.ClusterReference
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// Enables data tiering.
DataTiering() *string
SetDataTiering(val *string)
// A description of the cluster .
Description() *string
SetDescription(val *string)
// The name of the engine used by the cluster.
Engine() *string
SetEngine(val *string)
// The Redis engine version used by the cluster .
EngineVersion() *string
SetEngineVersion(val *string)
Env() *interfaces.ResourceEnvironment
// The user-supplied name of a final cluster snapshot.
FinalSnapshotName() *string
SetFinalSnapshotName(val *string)
// The mechanism that the cluster uses to discover IP addresses.
IpDiscovery() *string
SetIpDiscovery(val *string)
// The ID of the KMS key used to encrypt the 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.
LogicalId() *string
// Specifies the weekly time range during which maintenance on the cluster is performed.
MaintenanceWindow() *string
SetMaintenanceWindow(val *string)
// The name of the multi-Region cluster that this cluster belongs to.
MultiRegionClusterName() *string
SetMultiRegionClusterName(val *string)
// The IP address type for the cluster.
NetworkType() *string
SetNetworkType(val *string)
// The tree node.
Node() constructs.Node
// The cluster 's node type.
NodeType() *string
SetNodeType(val *string)
// The number of replicas to apply to each shard.
NumReplicasPerShard() *float64
SetNumReplicasPerShard(val *float64)
// The number of shards in the cluster .
NumShards() *float64
SetNumShards(val *float64)
// The name of the parameter group used by the cluster .
ParameterGroupName() *string
SetParameterGroupName(val *string)
// The port used by the cluster .
Port() *float64
SetPort(val *float64)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// A list of security group names to associate with this cluster .
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
// A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
SnapshotArns() *[]*string
SetSnapshotArns(val *[]*string)
// The name of a snapshot from which to restore data into the new cluster .
SnapshotName() *string
SetSnapshotName(val *string)
// The number of days for which MemoryDB retains automatic snapshots before deleting them.
SnapshotRetentionLimit() *float64
SetSnapshotRetentionLimit(val *float64)
// The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
SnapshotWindow() *string
SetSnapshotWindow(val *string)
// When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.
SnsTopicArn() *string
SetSnsTopicArn(val *string)
// The SNS topic must be in Active status to receive notifications.
SnsTopicStatus() *string
SetSnsTopicStatus(val *string)
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The name of the subnet group used by the cluster .
SubnetGroupName() *string
SetSubnetGroupName(val *string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// A flag to indicate if In-transit encryption is enabled.
TlsEnabled() interface{}
SetTlsEnabled(val interface{})
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Specifies a cluster .
All nodes in the cluster run the same protocol-compliant engine software.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnCluster := awscdk.Aws_memorydb.NewCfnCluster(this, jsii.String("MyCfnCluster"), &CfnClusterProps{
AclName: jsii.String("aclName"),
ClusterName: jsii.String("clusterName"),
NodeType: jsii.String("nodeType"),
// the properties below are optional
AutoMinorVersionUpgrade: jsii.Boolean(false),
ClusterEndpoint: &EndpointProperty{
Address: jsii.String("address"),
Port: jsii.Number(123),
},
DataTiering: jsii.String("dataTiering"),
Description: jsii.String("description"),
Engine: jsii.String("engine"),
EngineVersion: jsii.String("engineVersion"),
FinalSnapshotName: jsii.String("finalSnapshotName"),
IpDiscovery: jsii.String("ipDiscovery"),
KmsKeyId: jsii.String("kmsKeyId"),
MaintenanceWindow: jsii.String("maintenanceWindow"),
MultiRegionClusterName: jsii.String("multiRegionClusterName"),
NetworkType: jsii.String("networkType"),
NumReplicasPerShard: jsii.Number(123),
NumShards: jsii.Number(123),
ParameterGroupName: jsii.String("parameterGroupName"),
Port: jsii.Number(123),
SecurityGroupIds: []interface{}{
jsii.String("securityGroupIds"),
},
SnapshotArns: []*string{
jsii.String("snapshotArns"),
},
SnapshotName: jsii.String("snapshotName"),
SnapshotRetentionLimit: jsii.Number(123),
SnapshotWindow: jsii.String("snapshotWindow"),
SnsTopicArn: jsii.String("snsTopicArn"),
SnsTopicStatus: jsii.String("snsTopicStatus"),
SubnetGroupName: jsii.String("subnetGroupName"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TlsEnabled: jsii.Boolean(false),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html
func NewCfnCluster ¶
func NewCfnCluster(scope constructs.Construct, id *string, props *CfnClusterProps) CfnCluster
Create a new `AWS::MemoryDB::Cluster`.
type CfnClusterProps ¶
type CfnClusterProps struct {
// The name of the Access Control List to associate with the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-aclname
//
AclName *string `field:"required" json:"aclName" yaml:"aclName"`
// The name of the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clustername
//
ClusterName *string `field:"required" json:"clusterName" yaml:"clusterName"`
// The cluster 's node type.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-nodetype
//
NodeType *string `field:"required" json:"nodeType" yaml:"nodeType"`
// When set to true, the cluster will automatically receive minor engine version upgrades after launch.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-autominorversionupgrade
//
AutoMinorVersionUpgrade interface{} `field:"optional" json:"autoMinorVersionUpgrade" yaml:"autoMinorVersionUpgrade"`
// The cluster 's configuration endpoint.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-clusterendpoint
//
ClusterEndpoint interface{} `field:"optional" json:"clusterEndpoint" yaml:"clusterEndpoint"`
// Enables data tiering.
//
// Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see [Data tiering](https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-datatiering
//
DataTiering *string `field:"optional" json:"dataTiering" yaml:"dataTiering"`
// A description of the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The name of the engine used by the cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-engine
//
Engine *string `field:"optional" json:"engine" yaml:"engine"`
// The Redis engine version used by the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-engineversion
//
EngineVersion *string `field:"optional" json:"engineVersion" yaml:"engineVersion"`
// The user-supplied name of a final cluster snapshot.
//
// This is the unique name that identifies the snapshot. MemoryDB creates the snapshot, and then deletes the cluster immediately afterward.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-finalsnapshotname
//
FinalSnapshotName *string `field:"optional" json:"finalSnapshotName" yaml:"finalSnapshotName"`
// The mechanism that the cluster uses to discover IP addresses.
//
// Returns 'ipv4' when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-ipdiscovery
//
IpDiscovery *string `field:"optional" json:"ipDiscovery" yaml:"ipDiscovery"`
// The ID of the KMS key used to encrypt the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-kmskeyid
//
KmsKeyId *string `field:"optional" json:"kmsKeyId" yaml:"kmsKeyId"`
// Specifies the weekly time range during which maintenance on the cluster is performed.
//
// It is specified as a range in the format `ddd:hh24:mi-ddd:hh24:mi` (24H Clock UTC). The minimum maintenance window is a 60 minute period.
//
// *Pattern* : `ddd:hh24:mi-ddd:hh24:mi`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-maintenancewindow
//
MaintenanceWindow *string `field:"optional" json:"maintenanceWindow" yaml:"maintenanceWindow"`
// The name of the multi-Region cluster that this cluster belongs to.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-multiregionclustername
//
MultiRegionClusterName *string `field:"optional" json:"multiRegionClusterName" yaml:"multiRegionClusterName"`
// The IP address type for the cluster.
//
// Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6 addressing.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-networktype
//
NetworkType *string `field:"optional" json:"networkType" yaml:"networkType"`
// The number of replicas to apply to each shard.
//
// *Default value* : `1`
//
// *Maximum value* : `5`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numreplicaspershard
//
NumReplicasPerShard *float64 `field:"optional" json:"numReplicasPerShard" yaml:"numReplicasPerShard"`
// The number of shards in the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-numshards
//
NumShards *float64 `field:"optional" json:"numShards" yaml:"numShards"`
// The name of the parameter group used by the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-parametergroupname
//
ParameterGroupName *string `field:"optional" json:"parameterGroupName" yaml:"parameterGroupName"`
// The port used by the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-port
//
Port *float64 `field:"optional" json:"port" yaml:"port"`
// A list of security group names to associate with this cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-securitygroupids
//
SecurityGroupIds *[]interface{} `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"`
// A list of Amazon Resource Names (ARN) that uniquely identify the RDB snapshot files stored in Amazon S3.
//
// The snapshot files are used to populate the new cluster . The Amazon S3 object name in the ARN cannot contain any commas.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotarns
//
SnapshotArns *[]*string `field:"optional" json:"snapshotArns" yaml:"snapshotArns"`
// The name of a snapshot from which to restore data into the new cluster .
//
// The snapshot status changes to restoring while the new cluster is being created.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotname
//
SnapshotName *string `field:"optional" json:"snapshotName" yaml:"snapshotName"`
// The number of days for which MemoryDB retains automatic snapshots before deleting them.
//
// For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotretentionlimit
//
SnapshotRetentionLimit *float64 `field:"optional" json:"snapshotRetentionLimit" yaml:"snapshotRetentionLimit"`
// The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard.
//
// Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snapshotwindow
//
SnapshotWindow *string `field:"optional" json:"snapshotWindow" yaml:"snapshotWindow"`
// When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the SNS topic, such as `arn:aws:memorydb:us-east-1:123456789012:mySNSTopic`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicarn
//
SnsTopicArn *string `field:"optional" json:"snsTopicArn" yaml:"snsTopicArn"`
// The SNS topic must be in Active status to receive notifications.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-snstopicstatus
//
SnsTopicStatus *string `field:"optional" json:"snsTopicStatus" yaml:"snsTopicStatus"`
// The name of the subnet group used by the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-subnetgroupname
//
SubnetGroupName *string `field:"optional" json:"subnetGroupName" yaml:"subnetGroupName"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// A flag to indicate if In-transit encryption is enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html#cfn-memorydb-cluster-tlsenabled
//
TlsEnabled interface{} `field:"optional" json:"tlsEnabled" yaml:"tlsEnabled"`
}
Properties for defining a `CfnCluster`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnClusterProps := &CfnClusterProps{
AclName: jsii.String("aclName"),
ClusterName: jsii.String("clusterName"),
NodeType: jsii.String("nodeType"),
// the properties below are optional
AutoMinorVersionUpgrade: jsii.Boolean(false),
ClusterEndpoint: &EndpointProperty{
Address: jsii.String("address"),
Port: jsii.Number(123),
},
DataTiering: jsii.String("dataTiering"),
Description: jsii.String("description"),
Engine: jsii.String("engine"),
EngineVersion: jsii.String("engineVersion"),
FinalSnapshotName: jsii.String("finalSnapshotName"),
IpDiscovery: jsii.String("ipDiscovery"),
KmsKeyId: jsii.String("kmsKeyId"),
MaintenanceWindow: jsii.String("maintenanceWindow"),
MultiRegionClusterName: jsii.String("multiRegionClusterName"),
NetworkType: jsii.String("networkType"),
NumReplicasPerShard: jsii.Number(123),
NumShards: jsii.Number(123),
ParameterGroupName: jsii.String("parameterGroupName"),
Port: jsii.Number(123),
SecurityGroupIds: []interface{}{
jsii.String("securityGroupIds"),
},
SnapshotArns: []*string{
jsii.String("snapshotArns"),
},
SnapshotName: jsii.String("snapshotName"),
SnapshotRetentionLimit: jsii.Number(123),
SnapshotWindow: jsii.String("snapshotWindow"),
SnsTopicArn: jsii.String("snsTopicArn"),
SnsTopicStatus: jsii.String("snsTopicStatus"),
SubnetGroupName: jsii.String("subnetGroupName"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TlsEnabled: jsii.Boolean(false),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-cluster.html
type CfnCluster_EndpointProperty ¶
type CfnCluster_EndpointProperty struct {
// The DNS hostname of the node.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html#cfn-memorydb-cluster-endpoint-address
//
Address *string `field:"optional" json:"address" yaml:"address"`
// The port number that the engine is listening on.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-cluster-endpoint.html#cfn-memorydb-cluster-endpoint-port
//
Port *float64 `field:"optional" json:"port" yaml:"port"`
}
Represents the information required for client programs to connect to the cluster and its nodes.
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"
endpointProperty := &EndpointProperty{
Address: jsii.String("address"),
Port: jsii.Number(123),
}
type CfnMultiRegionCluster ¶ added in v2.173.0
type CfnMultiRegionCluster interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsmemorydb.IMultiRegionClusterRef
awscdk.ITaggableV2
// The Amazon Resource Name (ARN) of the multi-Region cluster.
AttrArn() *string
// The name of the multi-Region cluster.
AttrMultiRegionClusterName() *string
// The current status of the multi-Region cluster.
AttrStatus() *string
// Tag Manager which manages the tags for this resource.
CdkTagManager() awscdk.TagManager
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
// The description of the multi-Region cluster.
Description() *string
SetDescription(val *string)
// The name of the engine used by the multi-Region cluster.
Engine() *string
SetEngine(val *string)
// The version of the engine used by the multi-Region cluster.
EngineVersion() *string
SetEngineVersion(val *string)
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// A suffix to be added to the Multi-Region cluster name.
MultiRegionClusterNameSuffix() *string
SetMultiRegionClusterNameSuffix(val *string)
// A reference to a MultiRegionCluster resource.
MultiRegionClusterRef() *interfacesawsmemorydb.MultiRegionClusterReference
// The name of the multi-Region parameter group associated with the cluster.
MultiRegionParameterGroupName() *string
SetMultiRegionParameterGroupName(val *string)
// The tree node.
Node() constructs.Node
// The node type used by the multi-Region cluster.
NodeType() *string
SetNodeType(val *string)
// The number of shards in the multi-Region cluster.
NumShards() *float64
SetNumShards(val *float64)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A list of tags to be applied to the multi-Region cluster.
Tags() *[]*awscdk.CfnTag
SetTags(val *[]*awscdk.CfnTag)
// Indiciates if the multi-Region cluster is TLS enabled.
TlsEnabled() interface{}
SetTlsEnabled(val interface{})
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The strategy to use for the update operation.
UpdateStrategy() *string
SetUpdateStrategy(val *string)
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Represents a multi-Region 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"
cfnMultiRegionCluster := awscdk.Aws_memorydb.NewCfnMultiRegionCluster(this, jsii.String("MyCfnMultiRegionCluster"), &CfnMultiRegionClusterProps{
NodeType: jsii.String("nodeType"),
// the properties below are optional
Description: jsii.String("description"),
Engine: jsii.String("engine"),
EngineVersion: jsii.String("engineVersion"),
MultiRegionClusterNameSuffix: jsii.String("multiRegionClusterNameSuffix"),
MultiRegionParameterGroupName: jsii.String("multiRegionParameterGroupName"),
NumShards: jsii.Number(123),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TlsEnabled: jsii.Boolean(false),
UpdateStrategy: jsii.String("updateStrategy"),
})
func NewCfnMultiRegionCluster ¶ added in v2.173.0
func NewCfnMultiRegionCluster(scope constructs.Construct, id *string, props *CfnMultiRegionClusterProps) CfnMultiRegionCluster
Create a new `AWS::MemoryDB::MultiRegionCluster`.
type CfnMultiRegionClusterProps ¶ added in v2.173.0
type CfnMultiRegionClusterProps struct {
// The node type used by the multi-Region cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-nodetype
//
NodeType *string `field:"required" json:"nodeType" yaml:"nodeType"`
// The description of the multi-Region cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// The name of the engine used by the multi-Region cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-engine
//
Engine *string `field:"optional" json:"engine" yaml:"engine"`
// The version of the engine used by the multi-Region cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-engineversion
//
EngineVersion *string `field:"optional" json:"engineVersion" yaml:"engineVersion"`
// A suffix to be added to the Multi-Region cluster name.
//
// Amazon MemoryDB automatically applies a prefix to the Multi-Region cluster Name when it is created. Each Amazon Region has its own prefix. For instance, a Multi-Region cluster Name created in the US-West-1 region will begin with "virxk", along with the suffix name you provide. The suffix guarantees uniqueness of the Multi-Region cluster name across multiple regions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-multiregionclusternamesuffix
//
MultiRegionClusterNameSuffix *string `field:"optional" json:"multiRegionClusterNameSuffix" yaml:"multiRegionClusterNameSuffix"`
// The name of the multi-Region parameter group associated with the cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-multiregionparametergroupname
//
MultiRegionParameterGroupName *string `field:"optional" json:"multiRegionParameterGroupName" yaml:"multiRegionParameterGroupName"`
// The number of shards in the multi-Region cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-numshards
//
NumShards *float64 `field:"optional" json:"numShards" yaml:"numShards"`
// A list of tags to be applied to the multi-Region cluster.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
// Indiciates if the multi-Region cluster is TLS enabled.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-tlsenabled
//
TlsEnabled interface{} `field:"optional" json:"tlsEnabled" yaml:"tlsEnabled"`
// The strategy to use for the update operation.
//
// Supported values are "coordinated" or "uncoordinated".
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-multiregioncluster.html#cfn-memorydb-multiregioncluster-updatestrategy
//
UpdateStrategy *string `field:"optional" json:"updateStrategy" yaml:"updateStrategy"`
}
Properties for defining a `CfnMultiRegionCluster`.
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"
cfnMultiRegionClusterProps := &CfnMultiRegionClusterProps{
NodeType: jsii.String("nodeType"),
// the properties below are optional
Description: jsii.String("description"),
Engine: jsii.String("engine"),
EngineVersion: jsii.String("engineVersion"),
MultiRegionClusterNameSuffix: jsii.String("multiRegionClusterNameSuffix"),
MultiRegionParameterGroupName: jsii.String("multiRegionParameterGroupName"),
NumShards: jsii.Number(123),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
TlsEnabled: jsii.Boolean(false),
UpdateStrategy: jsii.String("updateStrategy"),
}
type CfnParameterGroup ¶
type CfnParameterGroup interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsmemorydb.IParameterGroupRef
awscdk.ITaggable
// When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the parameter group, such as `arn:aws:memorydb:us-east-1:123456789012:parametergroup/my-parameter-group`.
AttrArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
// A description of the parameter group.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The name of the parameter group family that this parameter group is compatible with.
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.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The name of the parameter group.
ParameterGroupName() *string
SetParameterGroupName(val *string)
// A reference to a ParameterGroup resource.
ParameterGroupRef() *interfacesawsmemorydb.ParameterGroupReference
// Returns the detailed parameter list for the parameter group.
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 })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Specifies a new MemoryDB parameter group.
A parameter group is a collection of parameters and their values that are applied to all of the nodes in any cluster . For more information, see [Configuring engine parameters using parameter groups](https://docs.aws.amazon.com/memorydb/latest/devguide/parametergroups.html) .
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{}
cfnParameterGroup := awscdk.Aws_memorydb.NewCfnParameterGroup(this, jsii.String("MyCfnParameterGroup"), &CfnParameterGroupProps{
Family: jsii.String("family"),
ParameterGroupName: jsii.String("parameterGroupName"),
// the properties below are optional
Description: jsii.String("description"),
Parameters: parameters,
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnParameterGroup ¶
func NewCfnParameterGroup(scope constructs.Construct, id *string, props *CfnParameterGroupProps) CfnParameterGroup
Create a new `AWS::MemoryDB::ParameterGroup`.
type CfnParameterGroupProps ¶
type CfnParameterGroupProps struct {
// The name of the parameter group family that this parameter group is compatible with.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-family
//
Family *string `field:"required" json:"family" yaml:"family"`
// The name of the parameter group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-parametergroupname
//
ParameterGroupName *string `field:"required" json:"parameterGroupName" yaml:"parameterGroupName"`
// A description of the parameter group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// Returns the detailed parameter list for the parameter group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-parameters
//
Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnParameterGroup`.
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{}
cfnParameterGroupProps := &CfnParameterGroupProps{
Family: jsii.String("family"),
ParameterGroupName: jsii.String("parameterGroupName"),
// the properties below are optional
Description: jsii.String("description"),
Parameters: parameters,
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnSubnetGroup ¶
type CfnSubnetGroup interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsmemorydb.ISubnetGroupRef
awscdk.ITaggable
// When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the subnet group, such as `arn:aws:memorydb:us-east-1:123456789012:subnetgroup/my-subnet-group`.
AttrArn() *string
// The network types supported by this subnet.
//
// Returns an array of strings that can include 'ipv4', 'ipv6', or both, indicating whether the subnet supports IPv4 only, IPv6 only, or dual-stack deployments.
AttrSupportedNetworkTypes() *[]*string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
// A description of the subnet group.
Description() *string
SetDescription(val *string)
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// The name of the subnet group to be used for the cluster .
SubnetGroupName() *string
SetSubnetGroupName(val *string)
// A reference to a SubnetGroup resource.
SubnetGroupRef() *interfacesawsmemorydb.SubnetGroupReference
// A list of Amazon VPC subnet IDs for the subnet group.
SubnetIds() *[]*string
SetSubnetIds(val *[]*string)
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Specifies a subnet group.
A subnet group is a collection of subnets (typically private) that you can designate for your cluster s running in an Amazon Virtual Private Cloud (VPC) environment. When you create a cluster in an Amazon VPC , you must specify a subnet group. MemoryDB uses that subnet group to choose a subnet and IP addresses within that subnet to associate with your nodes. For more information, see [Subnets and subnet groups](https://docs.aws.amazon.com/memorydb/latest/devguide/subnetgroups.html) .
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"
cfnSubnetGroup := awscdk.Aws_memorydb.NewCfnSubnetGroup(this, jsii.String("MyCfnSubnetGroup"), &CfnSubnetGroupProps{
SubnetGroupName: jsii.String("subnetGroupName"),
SubnetIds: []interface{}{
jsii.String("subnetIds"),
},
// the properties below are optional
Description: jsii.String("description"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html
func NewCfnSubnetGroup ¶
func NewCfnSubnetGroup(scope constructs.Construct, id *string, props *CfnSubnetGroupProps) CfnSubnetGroup
Create a new `AWS::MemoryDB::SubnetGroup`.
type CfnSubnetGroupProps ¶
type CfnSubnetGroupProps struct {
// The name of the subnet group to be used for the cluster .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetgroupname
//
SubnetGroupName *string `field:"required" json:"subnetGroupName" yaml:"subnetGroupName"`
// A list of Amazon VPC subnet IDs for the subnet group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-subnetids
//
SubnetIds *[]interface{} `field:"required" json:"subnetIds" yaml:"subnetIds"`
// A description of the subnet group.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-description
//
Description *string `field:"optional" json:"description" yaml:"description"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html#cfn-memorydb-subnetgroup-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSubnetGroup`.
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"
cfnSubnetGroupProps := &CfnSubnetGroupProps{
SubnetGroupName: jsii.String("subnetGroupName"),
SubnetIds: []interface{}{
jsii.String("subnetIds"),
},
// the properties below are optional
Description: jsii.String("description"),
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-subnetgroup.html
type CfnUser ¶
type CfnUser interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawsmemorydb.IUserRef
awscdk.ITaggable
// Access permissions string used for this user.
AccessString() *string
SetAccessString(val *string)
// When you pass the logical ID of this resource to the intrinsic `Ref` function, Ref returns the ARN of the user, such as `arn:aws:memorydb:us-east-1:123456789012:user/user1`.
AttrArn() *string
// Indicates the user status.
//
// *Valid values* : `active` | `modifying` | `deleting`.
AttrStatus() *string
// Denotes whether the user requires a password to authenticate.
AuthenticationMode() interface{}
SetAuthenticationMode(val interface{})
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
// AWS resource type.
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.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// An array of key-value pairs to apply to this resource.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// The name of the user.
UserName() *string
SetUserName(val *string)
// A reference to a User resource.
UserRef() *interfacesawsmemorydb.UserReference
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
// Deprecated: use addDependency.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Get a shallow copy of dependencies between this resource and other resources in the same stack.
ObtainResourceDependencies() *[]awscdk.CfnResource
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
}
Specifies a MemoryDB user.
For more information, see [Authenticating users with Access Contol Lists (ACLs)](https://docs.aws.amazon.com/memorydb/latest/devguide/clusters.acls.html) .
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 authenticationMode interface{}
cfnUser := awscdk.Aws_memorydb.NewCfnUser(this, jsii.String("MyCfnUser"), &CfnUserProps{
UserName: jsii.String("userName"),
// the properties below are optional
AccessString: jsii.String("accessString"),
AuthenticationMode: authenticationMode,
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html
func NewCfnUser ¶
func NewCfnUser(scope constructs.Construct, id *string, props *CfnUserProps) CfnUser
Create a new `AWS::MemoryDB::User`.
type CfnUserProps ¶
type CfnUserProps struct {
// The name of the user.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#cfn-memorydb-user-username
//
UserName *string `field:"required" json:"userName" yaml:"userName"`
// Access permissions string used for this user.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#cfn-memorydb-user-accessstring
//
AccessString *string `field:"optional" json:"accessString" yaml:"accessString"`
// Denotes whether the user requires a password to authenticate.
//
// *Example:*
//
// `mynewdbuser: Type: AWS::MemoryDB::User Properties: AccessString: on ~* &* +@all AuthenticationMode: Passwords: '1234567890123456' Type: password UserName: mynewdbuser AuthenticationMode: { "Passwords": ["1234567890123456"], "Type": "Password" }`.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#cfn-memorydb-user-authenticationmode
//
AuthenticationMode interface{} `field:"optional" json:"authenticationMode" yaml:"authenticationMode"`
// An array of key-value pairs to apply to this resource.
//
// For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html#cfn-memorydb-user-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnUser`.
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 authenticationMode interface{}
cfnUserProps := &CfnUserProps{
UserName: jsii.String("userName"),
// the properties below are optional
AccessString: jsii.String("accessString"),
AuthenticationMode: authenticationMode,
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-user.html
type CfnUser_AuthenticationModeProperty ¶ added in v2.55.0
type CfnUser_AuthenticationModeProperty struct {
// The password(s) used for authentication.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-user-authenticationmode.html#cfn-memorydb-user-authenticationmode-passwords
//
Passwords *[]*string `field:"optional" json:"passwords" yaml:"passwords"`
// Indicates whether the user requires a password to authenticate.
//
// All newly-created users require a password.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-memorydb-user-authenticationmode.html#cfn-memorydb-user-authenticationmode-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
}
Denotes the user's authentication properties, such as whether it requires a password to authenticate.
Used in output responses.
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"
authenticationModeProperty := &AuthenticationModeProperty{
Passwords: []*string{
jsii.String("passwords"),
},
Type: jsii.String("type"),
}
Source Files
¶
- CfnACL.go
- CfnACLProps.go
- CfnACL__checks.go
- CfnCluster.go
- CfnClusterProps.go
- CfnCluster_EndpointProperty.go
- CfnCluster__checks.go
- CfnMultiRegionCluster.go
- CfnMultiRegionClusterProps.go
- CfnMultiRegionCluster__checks.go
- CfnParameterGroup.go
- CfnParameterGroupProps.go
- CfnParameterGroup__checks.go
- CfnSubnetGroup.go
- CfnSubnetGroupProps.go
- CfnSubnetGroup__checks.go
- CfnUser.go
- CfnUserProps.go
- CfnUser_AuthenticationModeProperty.go
- CfnUser__checks.go
- main.go