dbproxy

Documentation

Index

• type AuthFormat
  • func (strct *AuthFormat) MarshalJSON() ([]byte, error)
  • func (strct *AuthFormat) UnmarshalJSON(b []byte) error
• type Resource
  • func (strct *Resource) MarshalJSON() ([]byte, error)
  • func (strct *Resource) UnmarshalJSON(b []byte) error
• type TagFormat
  • func (strct *TagFormat) MarshalJSON() ([]byte, error)
  • func (strct *TagFormat) UnmarshalJSON(b []byte) error

Types

type AuthFormat

type AuthFormat struct {

	// The type of authentication that the proxy uses for connections from the proxy to the underlying database.
	AuthScheme string `json:"AuthScheme,omitempty"`

	// The type of authentication the proxy uses for connections from clients.
	ClientPasswordAuthType string `json:"ClientPasswordAuthType,omitempty"`

	// A user-specified description about the authentication used by a proxy to log in as a specific database user.
	Description string `json:"Description,omitempty"`

	// Whether to require or disallow Amazon Web Services Identity and Access Management (IAM) authentication for connections to the proxy. The ENABLED value is valid only for proxies with RDS for Microsoft SQL Server.
	IAMAuth string `json:"IAMAuth,omitempty"`

	// 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.
	SecretArn string `json:"SecretArn,omitempty"`
}

AuthFormat

func (*AuthFormat) MarshalJSON

func (strct *AuthFormat) MarshalJSON() ([]byte, error)

func (*AuthFormat) UnmarshalJSON

func (strct *AuthFormat) UnmarshalJSON(b []byte) error

type Resource

type Resource struct {

	// The authorization mechanism that the proxy uses.
	Auth []*AuthFormat `json:"Auth"`

	// The Amazon Resource Name (ARN) for the proxy.
	DBProxyArn string `json:"DBProxyArn,omitempty"`

	// The identifier for the proxy. This name must be unique for all proxies owned by your AWS account in the specified AWS Region.
	DBProxyName string `json:"DBProxyName"`

	// Whether the proxy includes detailed information about SQL statements in its logs.
	DebugLogging bool `json:"DebugLogging,omitempty"`

	// The endpoint that you can use to connect to the proxy. You include the endpoint value in the connection string for a database client application.
	Endpoint string `json:"Endpoint,omitempty"`

	// The kinds of databases that the proxy can connect to.
	EngineFamily string `json:"EngineFamily"`

	// The number of seconds that a connection to the proxy can be inactive before the proxy disconnects it.
	IdleClientTimeout int `json:"IdleClientTimeout,omitempty"`

	// A Boolean parameter that specifies whether Transport Layer Security (TLS) encryption is required for connections to the proxy.
	RequireTLS bool `json:"RequireTLS,omitempty"`

	// The Amazon Resource Name (ARN) of the IAM role that the proxy uses to access secrets in AWS Secrets Manager.
	RoleArn string `json:"RoleArn"`

	// An optional set of key-value pairs to associate arbitrary data of your choosing with the proxy.
	Tags []*TagFormat `json:"Tags,omitempty"`

	// VPC ID to associate with the new DB proxy.
	VpcId string `json:"VpcId,omitempty"`

	// VPC security group IDs to associate with the new proxy.
	VpcSecurityGroupIds []string `json:"VpcSecurityGroupIds,omitempty"`

	// VPC subnet IDs to associate with the new proxy.
	VpcSubnetIds []string `json:"VpcSubnetIds"`
}

Resource Resource schema for AWS::RDS::DBProxy

func (*Resource) MarshalJSON

func (strct *Resource) MarshalJSON() ([]byte, error)

func (*Resource) UnmarshalJSON

func (strct *Resource) UnmarshalJSON(b []byte) error

type TagFormat

type TagFormat struct {
	Key   string `json:"Key,omitempty"`
	Value string `json:"Value,omitempty"`
}

TagFormat

func (*TagFormat) MarshalJSON

func (strct *TagFormat) MarshalJSON() ([]byte, error)

func (*TagFormat) UnmarshalJSON

func (strct *TagFormat) UnmarshalJSON(b []byte) error