awscc.rds_dbproxy¶
Filters¶
event
reduce
value
Actions¶
delete¶
Parent base class for filters and actions.
properties:
type:
enum:
- delete
required:
- type
Permissions - rds:DescribeDBProxies, rds:DeleteDBProxy
update¶
Parent base class for filters and actions.
definitions:
AuthFormat:
properties:
AuthScheme:
description: 'The type of authentication that the proxy uses for connections
from the proxy to the underlying database. '
enum:
- SECRETS
type: string
Description:
description: 'A user-specified description about the authentication used by
a proxy to log in as a specific database user. '
type: string
IAMAuth:
description: 'Whether to require or disallow AWS Identity and Access Management
(IAM) authentication for connections to the proxy. '
enum:
- DISABLED
- REQUIRED
type: string
SecretArn:
description: 'The Amazon Resource Name (ARN) representing the secret that
the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
These secrets are stored within Amazon Secrets Manager. '
type: string
UserName:
description: The name of the database user to which the proxy connects.
type: string
type: object
TagFormat:
properties:
Key:
maxLength: 128
pattern: (\w|\d|\s|\\|-|\.:=+-)*
type: string
Value:
maxLength: 128
pattern: (\w|\d|\s|\\|-|\.:=+-)*
type: string
type: object
properties:
Auth:
description: The authorization mechanism that the proxy uses.
items:
properties:
AuthScheme:
description: 'The type of authentication that the proxy uses for connections
from the proxy to the underlying database. '
enum:
- SECRETS
type: string
Description:
description: 'A user-specified description about the authentication used
by a proxy to log in as a specific database user. '
type: string
IAMAuth:
description: 'Whether to require or disallow AWS Identity and Access Management
(IAM) authentication for connections to the proxy. '
enum:
- DISABLED
- REQUIRED
type: string
SecretArn:
description: 'The Amazon Resource Name (ARN) representing the secret that
the proxy uses to authenticate to the RDS DB instance or Aurora DB cluster.
These secrets are stored within Amazon Secrets Manager. '
type: string
UserName:
description: The name of the database user to which the proxy connects.
type: string
type: object
minItems: 1
type: array
DebugLogging:
description: Whether the proxy includes detailed information about SQL statements
in its logs.
type: boolean
IdleClientTimeout:
description: The number of seconds that a connection to the proxy can be inactive
before the proxy disconnects it.
type: integer
RequireTLS:
description: A Boolean parameter that specifies whether Transport Layer Security
(TLS) encryption is required for connections to the proxy.
type: boolean
RoleArn:
description: The Amazon Resource Name (ARN) of the IAM role that the proxy uses
to access secrets in AWS Secrets Manager.
type: string
Tags:
description: An optional set of key-value pairs to associate arbitrary data of
your choosing with the proxy.
items:
properties:
Key:
maxLength: 128
pattern: (\w|\d|\s|\\|-|\.:=+-)*
type: string
Value:
maxLength: 128
pattern: (\w|\d|\s|\\|-|\.:=+-)*
type: string
type: object
type: array
VpcSecurityGroupIds:
description: VPC security group IDs to associate with the new proxy.
items:
type: string
minItems: 1
type: array
type:
enum:
- update
Permissions - rds:ModifyDBProxy, rds:AddTagsToResource, rds:RemoveTagsFromResource, iam:PassRole