CfnDBProxyEndpoint¶
-
class
aws_cdk.aws_rds.
CfnDBProxyEndpoint
(scope, id, *, db_proxy_endpoint_name, db_proxy_name, vpc_subnet_ids, tags=None, target_role=None, vpc_security_group_ids=None)¶ Bases:
aws_cdk.core.CfnResource
A CloudFormation
AWS::RDS::DBProxyEndpoint
.The
AWS::RDS::DBProxyEndpoint
resource creates or updates a DB proxy endpoint. You can use custom proxy endpoints to access a proxy through a different VPC than the proxy’s default VPC.For more information about RDS Proxy, see AWS::RDS::DBProxy .
- CloudformationResource
AWS::RDS::DBProxyEndpoint
- Link
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-rds-dbproxyendpoint.html
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_rds as rds cfn_dBProxy_endpoint = rds.CfnDBProxyEndpoint(self, "MyCfnDBProxyEndpoint", db_proxy_endpoint_name="dbProxyEndpointName", db_proxy_name="dbProxyName", vpc_subnet_ids=["vpcSubnetIds"], # the properties below are optional tags=[rds.CfnDBProxyEndpoint.TagFormatProperty( key="key", value="value" )], target_role="targetRole", vpc_security_group_ids=["vpcSecurityGroupIds"] )
Create a new
AWS::RDS::DBProxyEndpoint
.- Parameters
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
db_proxy_endpoint_name (
str
) – The name of the DB proxy endpoint to create.db_proxy_name (
str
) – The name of the DB proxy associated with the DB proxy endpoint that you create.vpc_subnet_ids (
Sequence
[str
]) – The VPC subnet IDs for the DB proxy endpoint that you create. You can specify a different set of subnet IDs than for the original DB proxy.tags (
Optional
[Sequence
[Union
[TagFormatProperty
,Dict
[str
,Any
]]]]) – An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.target_role (
Optional
[str
]) – A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations. Valid Values:READ_WRITE | READ_ONLY
vpc_security_group_ids (
Optional
[Sequence
[str
]]) – The VPC security group IDs for the DB proxy endpoint that you create. You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
Methods
-
add_deletion_override
(path)¶ Syntactic sugar for
addOverride(path, undefined)
.- Parameters
path (
str
) – The path of the value to delete.- Return type
None
-
add_depends_on
(target)¶ 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.
- Parameters
target (
CfnResource
) –- Return type
None
-
add_metadata
(key, value)¶ Add a value to the CloudFormation Resource Metadata.
- Parameters
key (
str
) –value (
Any
) –
- 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.
- Return type
None
-
add_override
(path, value)¶ Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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.- Parameters
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type
None
-
add_property_deletion_override
(property_path)¶ Adds an override that deletes the value of a property from the resource definition.
- Parameters
property_path (
str
) – The path to the property.- Return type
None
-
add_property_override
(property_path, value)¶ Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type
None
-
apply_removal_policy
(policy=None, *, apply_to_update_replace_policy=None, default=None)¶ 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
).- Parameters
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type
None
-
get_att
(attribute_name)¶ 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.- Parameters
attribute_name (
str
) – The name of the attribute.- Return type
-
get_metadata
(key)¶ Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters
key (
str
) –- 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.
- Return type
Any
-
inspect
(inspector)¶ Examines the CloudFormation resource and discloses attributes.
- Parameters
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type
None
-
override_logical_id
(new_logical_id)¶ Overrides the auto-generated logical ID with a specific ID.
- Parameters
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type
None
-
to_string
()¶ Returns a string representation of this construct.
- Return type
str
- Returns
a string representation of this resource
Attributes
-
CFN_RESOURCE_TYPE_NAME
= 'AWS::RDS::DBProxyEndpoint'¶
-
attr_db_proxy_endpoint_arn
¶ The Amazon Resource Name (ARN) representing the DB proxy endpoint.
- CloudformationAttribute
DBProxyEndpointArn
- Return type
str
-
attr_endpoint
¶ The custom endpoint for the RDS DB instance or Aurora DB cluster.
- CloudformationAttribute
Endpoint
- Return type
str
-
attr_is_default
¶ A value that indicates whether this endpoint is the default endpoint for the associated DB proxy.
Default DB proxy endpoints always have read/write capability. Other endpoints that you associate with the DB proxy can be either read/write or read-only.
- CloudformationAttribute
IsDefault
- Return type
-
attr_vpc_id
¶ The VPC ID of the DB proxy endpoint.
- CloudformationAttribute
VpcId
- Return type
str
-
cfn_options
¶ Options for this resource, such as condition, update policy etc.
- Return type
-
cfn_resource_type
¶ AWS resource type.
- Return type
str
-
creation_stack
¶ return:
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.
- Return type
List
[str
]
-
db_proxy_endpoint_name
¶ The name of the DB proxy endpoint to create.
-
db_proxy_name
¶ The name of the DB proxy associated with the DB proxy endpoint that you create.
-
logical_id
¶ 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)
.- Return type
str
- Returns
the logical ID as a stringified token. This value will only get resolved during synthesis.
-
node
¶ The construct tree node associated with this construct.
- Return type
-
ref
¶ 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 })
.- Return type
str
-
stack
¶ The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- Return type
An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
-
target_role
¶ A value that indicates whether the DB proxy endpoint can be used for read/write or read-only operations.
Valid Values:
READ_WRITE | READ_ONLY
-
vpc_security_group_ids
¶ The VPC security group IDs for the DB proxy endpoint that you create.
You can specify a different set of security group IDs than for the original DB proxy. The default is the default security group for the VPC.
- Link
- Return type
Optional
[List
[str
]]
-
vpc_subnet_ids
¶ The VPC subnet IDs for the DB proxy endpoint that you create.
You can specify a different set of subnet IDs than for the original DB proxy.
Static Methods
-
classmethod
is_cfn_element
(x)¶ 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.- Parameters
x (
Any
) –- Return type
bool
- Returns
The construct as a stack element or undefined if it is not a stack element.
-
classmethod
is_cfn_resource
(construct)¶ Check whether the given construct is a CfnResource.
- Parameters
construct (
IConstruct
) –- Return type
bool
-
classmethod
is_construct
(x)¶ Return whether the given object is a Construct.
- Parameters
x (
Any
) –- Return type
bool
TagFormatProperty¶
-
class
CfnDBProxyEndpoint.
TagFormatProperty
(*, key=None, value=None)¶ Bases:
object
Metadata assigned to a DB proxy endpoint consisting of a key-value pair.
- Parameters
key (
Optional
[str
]) – A value is the optional value of the tag. The string value can be 1-256 Unicode characters in length and can’t be prefixed withaws:
. The string can contain only the set of Unicode letters, digits, white-space, ‘*’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([p{L}p{Z}p{N}*.:/=+-]*)$”).value (
Optional
[str
]) – Metadata assigned to a DB instance consisting of a key-value pair.
- Link
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_rds as rds tag_format_property = rds.CfnDBProxyEndpoint.TagFormatProperty( key="key", value="value" )
Attributes
-
key
¶ A value is the optional value of the tag.
The string value can be 1-256 Unicode characters in length and can’t be prefixed with
aws:
. The string can contain only the set of Unicode letters, digits, white-space, ‘*’, ‘.’, ‘/’, ‘=’, ‘+’, ‘-‘ (Java regex: “^([p{L}p{Z}p{N}*.:/=+-]*)$”).
-
value
¶ Metadata assigned to a DB instance consisting of a key-value pair.