Documentation
¶
Index ¶
- func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
- func CfnCluster_IsCfnElement(x interface{}) *bool
- func CfnCluster_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnCluster_IsConstruct(x interface{}) *bool
- func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnParameterGroup_IsCfnElement(x interface{}) *bool
- func CfnParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnParameterGroup_IsConstruct(x interface{}) *bool
- func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSubnetGroup_IsCfnElement(x interface{}) *bool
- func CfnSubnetGroup_IsCfnResource(construct constructs.IConstruct) *bool
- func CfnSubnetGroup_IsConstruct(x interface{}) *bool
- func NewCfnCluster_Override(c CfnCluster, scope awscdk.Construct, id *string, props *CfnClusterProps)
- func NewCfnParameterGroup_Override(c CfnParameterGroup, scope awscdk.Construct, id *string, ...)
- func NewCfnSubnetGroup_Override(c CfnSubnetGroup, scope awscdk.Construct, id *string, ...)
- type CfnCluster
- type CfnClusterProps
- type CfnCluster_SSESpecificationProperty
- type CfnParameterGroup
- type CfnParameterGroupProps
- type CfnSubnetGroup
- type CfnSubnetGroupProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnCluster_CFN_RESOURCE_TYPE_NAME ¶
func CfnCluster_CFN_RESOURCE_TYPE_NAME() *string
func CfnCluster_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. Experimental.
func CfnCluster_IsCfnResource ¶
func CfnCluster_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnCluster_IsConstruct ¶
func CfnCluster_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnParameterGroup_CFN_RESOURCE_TYPE_NAME() *string
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. Experimental.
func CfnParameterGroup_IsCfnResource ¶
func CfnParameterGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnParameterGroup_IsConstruct ¶
func CfnParameterGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnSubnetGroup_CFN_RESOURCE_TYPE_NAME() *string
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. Experimental.
func CfnSubnetGroup_IsCfnResource ¶
func CfnSubnetGroup_IsCfnResource(construct constructs.IConstruct) *bool
Check whether the given construct is a CfnResource. Experimental.
func CfnSubnetGroup_IsConstruct ¶
func CfnSubnetGroup_IsConstruct(x interface{}) *bool
Return whether the given object is a Construct. Experimental.
func NewCfnCluster_Override ¶
func NewCfnCluster_Override(c CfnCluster, scope awscdk.Construct, id *string, props *CfnClusterProps)
Create a new `AWS::DAX::Cluster`.
func NewCfnParameterGroup_Override ¶
func NewCfnParameterGroup_Override(c CfnParameterGroup, scope awscdk.Construct, id *string, props *CfnParameterGroupProps)
Create a new `AWS::DAX::ParameterGroup`.
func NewCfnSubnetGroup_Override ¶
func NewCfnSubnetGroup_Override(c CfnSubnetGroup, scope awscdk.Construct, id *string, props *CfnSubnetGroupProps)
Create a new `AWS::DAX::SubnetGroup`.
Types ¶
type CfnCluster ¶
type CfnCluster interface {
awscdk.CfnResource
awscdk.IInspectable
AttrArn() *string
AttrClusterDiscoveryEndpoint() *string
AttrClusterDiscoveryEndpointUrl() *string
AvailabilityZones() *[]*string
SetAvailabilityZones(val *[]*string)
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
ClusterEndpointEncryptionType() *string
SetClusterEndpointEncryptionType(val *string)
ClusterName() *string
SetClusterName(val *string)
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
IamRoleArn() *string
SetIamRoleArn(val *string)
LogicalId() *string
Node() awscdk.ConstructNode
NodeType() *string
SetNodeType(val *string)
NotificationTopicArn() *string
SetNotificationTopicArn(val *string)
ParameterGroupName() *string
SetParameterGroupName(val *string)
PreferredMaintenanceWindow() *string
SetPreferredMaintenanceWindow(val *string)
Ref() *string
ReplicationFactor() *float64
SetReplicationFactor(val *float64)
SecurityGroupIds() *[]*string
SetSecurityGroupIds(val *[]*string)
SseSpecification() interface{}
SetSseSpecification(val interface{})
Stack() awscdk.Stack
SubnetGroupName() *string
SetSubnetGroupName(val *string)
Tags() awscdk.TagManager
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::DAX::Cluster`.
Creates a DAX cluster. All nodes in the cluster run the same DAX caching software.
TODO: EXAMPLE
func NewCfnCluster ¶
func NewCfnCluster(scope awscdk.Construct, id *string, props *CfnClusterProps) CfnCluster
Create a new `AWS::DAX::Cluster`.
type CfnClusterProps ¶
type CfnClusterProps struct {
// A valid Amazon Resource Name (ARN) that identifies an IAM role.
//
// At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.
IamRoleArn *string `json:"iamRoleArn" yaml:"iamRoleArn"`
// The node type for the nodes in the cluster.
//
// (All nodes in a DAX cluster are of the same type.)
NodeType *string `json:"nodeType" yaml:"nodeType"`
// The number of nodes in the DAX cluster.
//
// A replication factor of 1 will create a single-node cluster, without any read replicas. For additional fault tolerance, you can create a multiple node cluster with one or more read replicas. To do this, set `ReplicationFactor` to a number between 3 (one primary and two read replicas) and 10 (one primary and nine read replicas). `If the AvailabilityZones` parameter is provided, its length must equal the `ReplicationFactor` .
//
// > AWS recommends that you have at least two read replicas per cluster.
ReplicationFactor *float64 `json:"replicationFactor" yaml:"replicationFactor"`
// The Availability Zones (AZs) in which the cluster nodes will reside after the cluster has been created or updated.
//
// If provided, the length of this list must equal the `ReplicationFactor` parameter. If you omit this parameter, DAX will spread the nodes across Availability Zones for the highest availability.
AvailabilityZones *[]*string `json:"availabilityZones" yaml:"availabilityZones"`
// The encryption type of the cluster's endpoint. Available values are:.
//
// - `NONE` - The cluster's endpoint will be unencrypted.
// - `TLS` - The cluster's endpoint will be encrypted with Transport Layer Security, and will provide an x509 certificate for authentication.
//
// The default value is `NONE` .
ClusterEndpointEncryptionType *string `json:"clusterEndpointEncryptionType" yaml:"clusterEndpointEncryptionType"`
// The name of the DAX cluster.
ClusterName *string `json:"clusterName" yaml:"clusterName"`
// The description of the cluster.
Description *string `json:"description" yaml:"description"`
// The Amazon Resource Name (ARN) of the Amazon SNS topic to which notifications will be sent.
//
// > The Amazon SNS topic owner must be same as the DAX cluster owner.
NotificationTopicArn *string `json:"notificationTopicArn" yaml:"notificationTopicArn"`
// The parameter group to be associated with the DAX cluster.
ParameterGroupName *string `json:"parameterGroupName" yaml:"parameterGroupName"`
// A range of time when maintenance of DAX cluster software will be performed.
//
// For example: `sun:01:00-sun:09:00` . Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.
PreferredMaintenanceWindow *string `json:"preferredMaintenanceWindow" yaml:"preferredMaintenanceWindow"`
// A list of security group IDs to be assigned to each node in the DAX cluster.
//
// (Each of the security group ID is system-generated.)
//
// If this parameter is not specified, DAX assigns the default VPC security group to each node.
SecurityGroupIds *[]*string `json:"securityGroupIds" yaml:"securityGroupIds"`
// Represents the settings used to enable server-side encryption on the cluster.
SseSpecification interface{} `json:"sseSpecification" yaml:"sseSpecification"`
// The name of the subnet group to be used for the replication group.
//
// > DAX clusters can only run in an Amazon VPC environment. All of the subnets that you specify in a subnet group must exist in the same VPC.
SubnetGroupName *string `json:"subnetGroupName" yaml:"subnetGroupName"`
// A set of tags to associate with the DAX cluster.
Tags interface{} `json:"tags" yaml:"tags"`
}
Properties for defining a `CfnCluster`.
TODO: EXAMPLE
type CfnCluster_SSESpecificationProperty ¶
type CfnCluster_SSESpecificationProperty struct {
// Indicates whether server-side encryption is enabled (true) or disabled (false) on the cluster.
SseEnabled interface{} `json:"sseEnabled" yaml:"sseEnabled"`
}
Represents the settings used to enable server-side encryption.
TODO: EXAMPLE
type CfnParameterGroup ¶
type CfnParameterGroup interface {
awscdk.CfnResource
awscdk.IInspectable
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
LogicalId() *string
Node() awscdk.ConstructNode
ParameterGroupName() *string
SetParameterGroupName(val *string)
ParameterNameValues() interface{}
SetParameterNameValues(val interface{})
Ref() *string
Stack() awscdk.Stack
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::DAX::ParameterGroup`.
A named set of parameters that are applied to all of the nodes in a DAX cluster.
TODO: EXAMPLE
func NewCfnParameterGroup ¶
func NewCfnParameterGroup(scope awscdk.Construct, id *string, props *CfnParameterGroupProps) CfnParameterGroup
Create a new `AWS::DAX::ParameterGroup`.
type CfnParameterGroupProps ¶
type CfnParameterGroupProps struct {
// A description of the parameter group.
Description *string `json:"description" yaml:"description"`
// The name of the parameter group.
ParameterGroupName *string `json:"parameterGroupName" yaml:"parameterGroupName"`
// An array of name-value pairs for the parameters in the group.
//
// Each element in the array represents a single parameter.
//
// > `record-ttl-millis` and `query-ttl-millis` are the only supported parameter names. For more details, see [Configuring TTL Settings](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DAX.cluster-management.html#DAX.cluster-management.custom-settings.ttl) .
ParameterNameValues interface{} `json:"parameterNameValues" yaml:"parameterNameValues"`
}
Properties for defining a `CfnParameterGroup`.
TODO: EXAMPLE
type CfnSubnetGroup ¶
type CfnSubnetGroup interface {
awscdk.CfnResource
awscdk.IInspectable
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnResourceType() *string
CreationStack() *[]*string
Description() *string
SetDescription(val *string)
LogicalId() *string
Node() awscdk.ConstructNode
Ref() *string
Stack() awscdk.Stack
SubnetGroupName() *string
SetSubnetGroupName(val *string)
SubnetIds() *[]*string
SetSubnetIds(val *[]*string)
UpdatedProperites() *map[string]interface{}
AddDeletionOverride(path *string)
AddDependsOn(target awscdk.CfnResource)
AddMetadata(key *string, value interface{})
AddOverride(path *string, value interface{})
AddPropertyDeletionOverride(propertyPath *string)
AddPropertyOverride(propertyPath *string, value interface{})
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
GetAtt(attributeName *string) awscdk.Reference
GetMetadata(key *string) interface{}
Inspect(inspector awscdk.TreeInspector)
OnPrepare()
OnSynthesize(session constructs.ISynthesisSession)
OnValidate() *[]*string
OverrideLogicalId(newLogicalId *string)
Prepare()
RenderProperties(props *map[string]interface{}) *map[string]interface{}
ShouldSynthesize() *bool
Synthesize(session awscdk.ISynthesisSession)
ToString() *string
Validate() *[]*string
ValidateProperties(_properties interface{})
}
A CloudFormation `AWS::DAX::SubnetGroup`.
Creates a new subnet group.
TODO: EXAMPLE
func NewCfnSubnetGroup ¶
func NewCfnSubnetGroup(scope awscdk.Construct, id *string, props *CfnSubnetGroupProps) CfnSubnetGroup
Create a new `AWS::DAX::SubnetGroup`.
type CfnSubnetGroupProps ¶
type CfnSubnetGroupProps struct {
// A list of VPC subnet IDs for the subnet group.
SubnetIds *[]*string `json:"subnetIds" yaml:"subnetIds"`
// The description of the subnet group.
Description *string `json:"description" yaml:"description"`
// The name of the subnet group.
SubnetGroupName *string `json:"subnetGroupName" yaml:"subnetGroupName"`
}
Properties for defining a `CfnSubnetGroup`.
TODO: EXAMPLE