software.amazon.awscdk.services.rds

Interface OptionConfiguration

All Known Implementing Classes:

OptionConfiguration.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:37:02.072Z")
public interface OptionConfiguration

Configuration properties for an option.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.ec2.*;
 import software.amazon.awscdk.services.rds.*;
 SecurityGroup securityGroup;
 Vpc vpc;
 OptionConfiguration optionConfiguration = OptionConfiguration.builder()
         .name("name")
         // the properties below are optional
         .port(123)
         .securityGroups(List.of(securityGroup))
         .settings(Map.of(
                 "settingsKey", "settings"))
         .version("version")
         .vpc(vpc)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	OptionConfiguration.Builder A builder for OptionConfiguration
static class	OptionConfiguration.Jsii$Proxy An implementation for OptionConfiguration

Method Summary

Modifier and Type	Method and Description
static OptionConfiguration.Builder	builder()
java.lang.String	getName() The name of the option.
default java.lang.Number	getPort() The port number that this option uses.
default java.util.List<ISecurityGroup>	getSecurityGroups() Optional list of security groups to use for this option, if `vpc` is specified.
default java.util.Map<java.lang.String,java.lang.String>	getSettings() The settings for the option.
default java.lang.String	getVersion() The version for the option.
default IVpc	getVpc() The VPC where a security group should be created for this option.

Method Detail

getName

java.lang.String getName()

The name of the option.

getPort

default java.lang.Number getPort()

The port number that this option uses.

If port is specified then vpc must also be specified.

Default: - no port

getSecurityGroups

default java.util.List<ISecurityGroup> getSecurityGroups()

Optional list of security groups to use for this option, if `vpc` is specified.

If no groups are provided, a default one will be created.

Default: - a default group will be created if `port` or `vpc` are specified.

getSettings

default java.util.Map<java.lang.String,java.lang.String> getSettings()

The settings for the option.

Default: - no settings

getVersion

default java.lang.String getVersion()

The version for the option.

Default: - no version

getVpc

default IVpc getVpc()

The VPC where a security group should be created for this option.

If vpc is specified then port must also be specified.

Default: - no VPC

builder

static OptionConfiguration.Builder builder()

Returns:

a OptionConfiguration.Builder of OptionConfiguration