rds_create_db_cluster_endpoint: Creates a new custom endpoint and associates it with an...

Description Usage Arguments Value Request syntax

View source: R/rds_operations.R

Description

Creates a new custom endpoint and associates it with an Amazon Aurora DB cluster.

This action only applies to Aurora DB clusters.

Usage

1
2
3
rds_create_db_cluster_endpoint(DBClusterIdentifier,
  DBClusterEndpointIdentifier, EndpointType, StaticMembers,
  ExcludedMembers, Tags)

Arguments

DBClusterIdentifier

[required] The DB cluster identifier of the DB cluster associated with the endpoint. This parameter is stored as a lowercase string.

DBClusterEndpointIdentifier

[required] The identifier to use for the new endpoint. This parameter is stored as a lowercase string.

EndpointType

[required] The type of the endpoint. One of: READER, WRITER, ANY.

StaticMembers

List of DB instance identifiers that are part of the custom endpoint group.

ExcludedMembers

List of DB instance identifiers that aren't part of the custom endpoint group. All other eligible instances are reachable through the custom endpoint. Only relevant if the list of static members is empty.

Tags

The tags to be assigned to the Amazon RDS resource.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
list(
  DBClusterEndpointIdentifier = "string",
  DBClusterIdentifier = "string",
  DBClusterEndpointResourceIdentifier = "string",
  Endpoint = "string",
  Status = "string",
  EndpointType = "string",
  CustomEndpointType = "string",
  StaticMembers = list(
    "string"
  ),
  ExcludedMembers = list(
    "string"
  ),
  DBClusterEndpointArn = "string"
)

Request syntax

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
svc$create_db_cluster_endpoint(
  DBClusterIdentifier = "string",
  DBClusterEndpointIdentifier = "string",
  EndpointType = "string",
  StaticMembers = list(
    "string"
  ),
  ExcludedMembers = list(
    "string"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

paws.database documentation built on Aug. 23, 2021, 9:18 a.m.