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

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.getOptionGroup

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.

    Using getOptionGroup

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getOptionGroup(args: GetOptionGroupArgs, opts?: InvokeOptions): Promise<GetOptionGroupResult>
function getOptionGroupOutput(args: GetOptionGroupOutputArgs, opts?: InvokeOptions): Output<GetOptionGroupResult>
    def get_option_group(option_group_name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetOptionGroupResult
def get_option_group_output(option_group_name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetOptionGroupResult]
    func LookupOptionGroup(ctx *Context, args *LookupOptionGroupArgs, opts ...InvokeOption) (*LookupOptionGroupResult, error)
func LookupOptionGroupOutput(ctx *Context, args *LookupOptionGroupOutputArgs, opts ...InvokeOption) LookupOptionGroupResultOutput

    > Note: This function is named LookupOptionGroup in the Go SDK.

    public static class GetOptionGroup 
{
    public static Task<GetOptionGroupResult> InvokeAsync(GetOptionGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetOptionGroupResult> Invoke(GetOptionGroupInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetOptionGroupResult> getOptionGroup(GetOptionGroupArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:rds:getOptionGroup
  arguments:
    # arguments dictionary

    The following arguments are supported:

    OptionGroupName string
    Specifies the name of the option group.
    OptionGroupName string
    Specifies the name of the option group.
    optionGroupName String
    Specifies the name of the option group.
    optionGroupName string
    Specifies the name of the option group.
    option_group_name str
    Specifies the name of the option group.
    optionGroupName String
    Specifies the name of the option group.

    getOptionGroup Result

    The following output properties are available:

    OptionConfigurations List<Pulumi.AwsNative.Rds.Outputs.OptionGroupOptionConfiguration>
    Indicates what options are available in the option group.
    Tags List<Pulumi.AwsNative.Outputs.Tag>
    An array of key-value pairs to apply to this resource.
    OptionConfigurations []OptionGroupOptionConfiguration
    Indicates what options are available in the option group.
    Tags Tag
    An array of key-value pairs to apply to this resource.
    optionConfigurations List<OptionGroupOptionConfiguration>
    Indicates what options are available in the option group.
    tags List<Tag>
    An array of key-value pairs to apply to this resource.
    optionConfigurations OptionGroupOptionConfiguration[]
    Indicates what options are available in the option group.
    tags Tag[]
    An array of key-value pairs to apply to this resource.
    option_configurations Sequence[OptionGroupOptionConfiguration]
    Indicates what options are available in the option group.
    tags Sequence[root_Tag]
    An array of key-value pairs to apply to this resource.
    optionConfigurations List<Property Map>
    Indicates what options are available in the option group.
    tags List<Property Map>
    An array of key-value pairs to apply to this resource.

    Supporting Types

    OptionGroupOptionConfiguration

    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

    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

    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