Package software.amazon.awscdk.services.rds

Class CfnOptionGroup

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.rds.CfnOptionGroup
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:49.072Z") @Stability(Stable) public class CfnOptionGroup extends CfnResource implements IInspectable
A CloudFormation AWS::RDS::OptionGroup.

The AWS::RDS::OptionGroup resource creates or updates an option group, to enable and configure features that are specific to a particular DB engine.

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.rds.*;
 CfnOptionGroup cfnOptionGroup = CfnOptionGroup.Builder.create(this, "MyCfnOptionGroup")
         .engineName("engineName")
         .majorEngineVersion("majorEngineVersion")
         .optionGroupDescription("optionGroupDescription")
         // the properties below are optional
         .optionConfigurations(List.of(OptionConfigurationProperty.builder()
                 .optionName("optionName")
                 // the properties below are optional
                 .dbSecurityGroupMemberships(List.of("dbSecurityGroupMemberships"))
                 .optionSettings(List.of(OptionSettingProperty.builder()
                         .name("name")
                         .value("value")
                         .build()))
                 .optionVersion("optionVersion")
                 .port(123)
                 .vpcSecurityGroupMemberships(List.of("vpcSecurityGroupMemberships"))
                 .build()))
         .optionGroupName("optionGroupName")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnOptionGroup

      protected CfnOptionGroup(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnOptionGroup

      protected CfnOptionGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnOptionGroup

      @Stability(Stable) public CfnOptionGroup(@NotNull Construct scope, @NotNull String id, @NotNull CfnOptionGroupProps props)
      Create a new AWS::RDS::OptionGroup.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      An optional array of key-value pairs to apply to this option group.

    • getEngineName

      @Stability(Stable) @NotNull public String getEngineName()
      Specifies the name of the engine that this option group should be associated with.

      Valid Values:

      • mariadb
      • mysql
      • oracle-ee
      • oracle-ee-cdb
      • oracle-se2
      • oracle-se2-cdb
      • postgres
      • sqlserver-ee
      • sqlserver-se
      • sqlserver-ex
      • sqlserver-web

    • setEngineName

      @Stability(Stable) public void setEngineName(@NotNull String value)
      Specifies the name of the engine that this option group should be associated with.

      Valid Values:

      • mariadb
      • mysql
      • oracle-ee
      • oracle-ee-cdb
      • oracle-se2
      • oracle-se2-cdb
      • postgres
      • sqlserver-ee
      • sqlserver-se
      • sqlserver-ex
      • sqlserver-web

    • getMajorEngineVersion

      @Stability(Stable) @NotNull public String getMajorEngineVersion()
      Specifies the major version of the engine that this option group should be associated with.

    • setMajorEngineVersion

      @Stability(Stable) public void setMajorEngineVersion(@NotNull String value)
      Specifies the major version of the engine that this option group should be associated with.

    • getOptionGroupDescription

      @Stability(Stable) @NotNull public String getOptionGroupDescription()
      The description of the option group.

    • setOptionGroupDescription

      @Stability(Stable) public void setOptionGroupDescription(@NotNull String value)
      The description of the option group.

    • getOptionConfigurations

      @Stability(Stable) @Nullable public Object getOptionConfigurations()
      A list of options and the settings for each option.

    • setOptionConfigurations

      @Stability(Stable) public void setOptionConfigurations(@Nullable IResolvable value)
      A list of options and the settings for each option.

    • setOptionConfigurations

      @Stability(Stable) public void setOptionConfigurations(@Nullable List<Object> value)
      A list of options and the settings for each option.

    • getOptionGroupName

      @Stability(Stable) @Nullable public String getOptionGroupName()
      The name of the option group to be created.

      Constraints:

      • Must be 1 to 255 letters, numbers, or hyphens
      • First character must be a letter
      • Can't end with a hyphen or contain two consecutive hyphens

      Example: myoptiongroup

      If you don't specify a value for OptionGroupName property, a name is automatically created for the option group.

      This value is stored as a lowercase string.

    • setOptionGroupName

      @Stability(Stable) public void setOptionGroupName(@Nullable String value)
      The name of the option group to be created.

      Constraints:

      • Must be 1 to 255 letters, numbers, or hyphens
      • First character must be a letter
      • Can't end with a hyphen or contain two consecutive hyphens

      Example: myoptiongroup

      If you don't specify a value for OptionGroupName property, a name is automatically created for the option group.

      This value is stored as a lowercase string.