Skip to content

Copy Option Group

rds_copy_option_group R Documentation

Copies the specified option group

Description

Copies the specified option group.

Usage

rds_copy_option_group(SourceOptionGroupIdentifier,
  TargetOptionGroupIdentifier, TargetOptionGroupDescription, Tags)

Arguments

SourceOptionGroupIdentifier

[required] The identifier for the source option group.

Constraints:

  • Must specify a valid option group.

TargetOptionGroupIdentifier

[required] The identifier for the copied option group.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 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: my-option-group

TargetOptionGroupDescription

[required] The description for the copied option group.

Tags

A list of tags.

For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

Value

A list with the following syntax:

list(
  OptionGroup = list(
    OptionGroupName = "string",
    OptionGroupDescription = "string",
    EngineName = "string",
    MajorEngineVersion = "string",
    Options = list(
      list(
        OptionName = "string",
        OptionDescription = "string",
        Persistent = TRUE|FALSE,
        Permanent = TRUE|FALSE,
        Port = 123,
        OptionVersion = "string",
        OptionSettings = list(
          list(
            Name = "string",
            Value = "string",
            DefaultValue = "string",
            Description = "string",
            ApplyType = "string",
            DataType = "string",
            AllowedValues = "string",
            IsModifiable = TRUE|FALSE,
            IsCollection = TRUE|FALSE
          )
        ),
        DBSecurityGroupMemberships = list(
          list(
            DBSecurityGroupName = "string",
            Status = "string"
          )
        ),
        VpcSecurityGroupMemberships = list(
          list(
            VpcSecurityGroupId = "string",
            Status = "string"
          )
        )
      )
    ),
    AllowsVpcAndNonVpcInstanceMemberships = TRUE|FALSE,
    VpcId = "string",
    OptionGroupArn = "string",
    SourceOptionGroup = "string",
    SourceAccountId = "string",
    CopyTimestamp = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$copy_option_group(
  SourceOptionGroupIdentifier = "string",
  TargetOptionGroupIdentifier = "string",
  TargetOptionGroupDescription = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Examples

## Not run: 
# This example copies an option group.
svc$copy_option_group(
  SourceOptionGroupIdentifier = "mymysqloptiongroup",
  TargetOptionGroupDescription = "My MySQL option group copy",
  TargetOptionGroupIdentifier = "mymysqloptiongroup-copy"
)

## End(Not run)