Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. rds
  5. OptionGroup

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.rds.OptionGroup

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

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

    Create OptionGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OptionGroup(name: string, args: OptionGroupArgs, opts?: CustomResourceOptions);
    @overload
def OptionGroup(resource_name: str,
                args: OptionGroupArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def OptionGroup(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                engine_name: Optional[str] = None,
                major_engine_version: Optional[str] = None,
                option_group_description: Optional[str] = None,
                option_configurations: Optional[Sequence[OptionGroupOptionConfigurationArgs]] = None,
                option_group_name: Optional[str] = None,
                tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewOptionGroup(ctx *Context, name string, args OptionGroupArgs, opts ...ResourceOption) (*OptionGroup, error)
    public OptionGroup(string name, OptionGroupArgs args, CustomResourceOptions? opts = null)
    public OptionGroup(String name, OptionGroupArgs args)
public OptionGroup(String name, OptionGroupArgs args, CustomResourceOptions options)

    type: aws-native:rds:OptionGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OptionGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    OptionGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The OptionGroup resource accepts the following input properties:

    EngineName string
    Indicates the name of the engine that this option group can be applied to.
    MajorEngineVersion string
    Indicates the major engine version associated with this option group.
    OptionGroupDescription string
    Provides a description of the option group.
    OptionConfigurations List<Pulumi.AwsNative.Rds.Inputs.OptionGroupOptionConfiguration>
    Indicates what options are available in the option group.
    OptionGroupName string
    Specifies the name of the option group.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    An array of key-value pairs to apply to this resource.
    EngineName string
    Indicates the name of the engine that this option group can be applied to.
    MajorEngineVersion string
    Indicates the major engine version associated with this option group.
    OptionGroupDescription string
    Provides a description of the option group.
    OptionConfigurations []OptionGroupOptionConfigurationArgs
    Indicates what options are available in the option group.
    OptionGroupName string
    Specifies the name of the option group.
    Tags TagArgs
    An array of key-value pairs to apply to this resource.
    engineName String
    Indicates the name of the engine that this option group can be applied to.
    majorEngineVersion String
    Indicates the major engine version associated with this option group.
    optionGroupDescription String
    Provides a description of the option group.
    optionConfigurations List<OptionGroupOptionConfiguration>
    Indicates what options are available in the option group.
    optionGroupName String
    Specifies the name of the option group.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    engineName string
    Indicates the name of the engine that this option group can be applied to.
    majorEngineVersion string
    Indicates the major engine version associated with this option group.
    optionGroupDescription string
    Provides a description of the option group.
    optionConfigurations OptionGroupOptionConfiguration[]
    Indicates what options are available in the option group.
    optionGroupName string
    Specifies the name of the option group.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    engine_name str
    Indicates the name of the engine that this option group can be applied to.
    major_engine_version str
    Indicates the major engine version associated with this option group.
    option_group_description str
    Provides a description of the option group.
    option_configurations Sequence[OptionGroupOptionConfigurationArgs]
    Indicates what options are available in the option group.
    option_group_name str
    Specifies the name of the option group.
    tags Sequence[TagArgs]
    An array of key-value pairs to apply to this resource.
    engineName String
    Indicates the name of the engine that this option group can be applied to.
    majorEngineVersion String
    Indicates the major engine version associated with this option group.
    optionGroupDescription String
    Provides a description of the option group.
    optionConfigurations List<Property Map>
    Indicates what options are available in the option group.
    optionGroupName String
    Specifies the name of the option group.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OptionGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    OptionGroupOptionConfiguration, OptionGroupOptionConfigurationArgs

    OptionName string
    The configuration of options to include in a group.
    DbSecurityGroupMemberships List<string>
    A list of DBSecurityGroupMembership name strings used for this option.
    OptionSettings List<Pulumi.AwsNative.Rds.Inputs.OptionGroupOptionSetting>
    The option settings to include in an option group.
    OptionVersion string
    The version for the option.
    Port int
    The optional port for the option.
    VpcSecurityGroupMemberships List<string>
    A list of VpcSecurityGroupMembership name strings used for this option.
    OptionName string
    The configuration of options to include in a group.
    DbSecurityGroupMemberships []string
    A list of DBSecurityGroupMembership name strings used for this option.
    OptionSettings []OptionGroupOptionSetting
    The option settings to include in an option group.
    OptionVersion string
    The version for the option.
    Port int
    The optional port for the option.
    VpcSecurityGroupMemberships []string
    A list of VpcSecurityGroupMembership name strings used for this option.
    optionName String
    The configuration of options to include in a group.
    dbSecurityGroupMemberships List<String>
    A list of DBSecurityGroupMembership name strings used for this option.
    optionSettings List<OptionGroupOptionSetting>
    The option settings to include in an option group.
    optionVersion String
    The version for the option.
    port Integer
    The optional port for the option.
    vpcSecurityGroupMemberships List<String>
    A list of VpcSecurityGroupMembership name strings used for this option.
    optionName string
    The configuration of options to include in a group.
    dbSecurityGroupMemberships string[]
    A list of DBSecurityGroupMembership name strings used for this option.
    optionSettings OptionGroupOptionSetting[]
    The option settings to include in an option group.
    optionVersion string
    The version for the option.
    port number
    The optional port for the option.
    vpcSecurityGroupMemberships string[]
    A list of VpcSecurityGroupMembership name strings used for this option.
    option_name str
    The configuration of options to include in a group.
    db_security_group_memberships Sequence[str]
    A list of DBSecurityGroupMembership name strings used for this option.
    option_settings Sequence[OptionGroupOptionSetting]
    The option settings to include in an option group.
    option_version str
    The version for the option.
    port int
    The optional port for the option.
    vpc_security_group_memberships Sequence[str]
    A list of VpcSecurityGroupMembership name strings used for this option.
    optionName String
    The configuration of options to include in a group.
    dbSecurityGroupMemberships List<String>
    A list of DBSecurityGroupMembership name strings used for this option.
    optionSettings List<Property Map>
    The option settings to include in an option group.
    optionVersion String
    The version for the option.
    port Number
    The optional port for the option.
    vpcSecurityGroupMemberships List<String>
    A list of VpcSecurityGroupMembership name strings used for this option.

    OptionGroupOptionSetting, OptionGroupOptionSettingArgs

    Name string
    The name of the option that has settings that you can set.
    Value string
    The current value of the option setting.
    Name string
    The name of the option that has settings that you can set.
    Value string
    The current value of the option setting.
    name String
    The name of the option that has settings that you can set.
    value String
    The current value of the option setting.
    name string
    The name of the option that has settings that you can set.
    value string
    The current value of the option setting.
    name str
    The name of the option that has settings that you can set.
    value str
    The current value of the option setting.
    name String
    The name of the option that has settings that you can set.
    value String
    The current value of the option setting.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native