1. Packages
  2. F5 BIG-IP
  3. API Docs
  4. ltm
  5. DataGroup
f5 BIG-IP v3.17.1 published on Friday, May 10, 2024 by Pulumi

f5bigip.ltm.DataGroup

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.1 published on Friday, May 10, 2024 by Pulumi

    f5bigip.ltm.DataGroup Manages internal (in-line) datagroup configuration

    Resource should be named with theirfull path. The full path is the combination of the partition + name of the resource, for example /Common/my-datagroup.

    Create DataGroup Resource

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

    Constructor syntax

    new DataGroup(name: string, args: DataGroupArgs, opts?: CustomResourceOptions);
    @overload
    def DataGroup(resource_name: str,
                  args: DataGroupArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def DataGroup(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  name: Optional[str] = None,
                  type: Optional[str] = None,
                  internal: Optional[bool] = None,
                  records: Optional[Sequence[DataGroupRecordArgs]] = None,
                  records_src: Optional[str] = None)
    func NewDataGroup(ctx *Context, name string, args DataGroupArgs, opts ...ResourceOption) (*DataGroup, error)
    public DataGroup(string name, DataGroupArgs args, CustomResourceOptions? opts = null)
    public DataGroup(String name, DataGroupArgs args)
    public DataGroup(String name, DataGroupArgs args, CustomResourceOptions options)
    
    type: f5bigip:ltm:DataGroup
    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 DataGroupArgs
    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 DataGroupArgs
    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 DataGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DataGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DataGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var dataGroupResource = new F5BigIP.Ltm.DataGroup("dataGroupResource", new()
    {
        Name = "string",
        Type = "string",
        Internal = false,
        Records = new[]
        {
            new F5BigIP.Ltm.Inputs.DataGroupRecordArgs
            {
                Name = "string",
                Data = "string",
            },
        },
        RecordsSrc = "string",
    });
    
    example, err := ltm.NewDataGroup(ctx, "dataGroupResource", &ltm.DataGroupArgs{
    	Name:     pulumi.String("string"),
    	Type:     pulumi.String("string"),
    	Internal: pulumi.Bool(false),
    	Records: ltm.DataGroupRecordArray{
    		&ltm.DataGroupRecordArgs{
    			Name: pulumi.String("string"),
    			Data: pulumi.String("string"),
    		},
    	},
    	RecordsSrc: pulumi.String("string"),
    })
    
    var dataGroupResource = new DataGroup("dataGroupResource", DataGroupArgs.builder()
        .name("string")
        .type("string")
        .internal(false)
        .records(DataGroupRecordArgs.builder()
            .name("string")
            .data("string")
            .build())
        .recordsSrc("string")
        .build());
    
    data_group_resource = f5bigip.ltm.DataGroup("dataGroupResource",
        name="string",
        type="string",
        internal=False,
        records=[f5bigip.ltm.DataGroupRecordArgs(
            name="string",
            data="string",
        )],
        records_src="string")
    
    const dataGroupResource = new f5bigip.ltm.DataGroup("dataGroupResource", {
        name: "string",
        type: "string",
        internal: false,
        records: [{
            name: "string",
            data: "string",
        }],
        recordsSrc: "string",
    });
    
    type: f5bigip:ltm:DataGroup
    properties:
        internal: false
        name: string
        records:
            - data: string
              name: string
        recordsSrc: string
        type: string
    

    DataGroup 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 DataGroup resource accepts the following input properties:

    Name string
    Name of the datagroup
    Type string
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    Internal bool
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    Records List<Pulumi.F5BigIP.Ltm.Inputs.DataGroupRecord>
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    RecordsSrc string
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    Name string
    Name of the datagroup
    Type string
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    Internal bool
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    Records []DataGroupRecordArgs
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    RecordsSrc string
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    name String
    Name of the datagroup
    type String
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    internal Boolean
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    records List<DataGroupRecord>
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    recordsSrc String
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    name string
    Name of the datagroup
    type string
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    internal boolean
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    records DataGroupRecord[]
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    recordsSrc string
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    name str
    Name of the datagroup
    type str
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    internal bool
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    records Sequence[DataGroupRecordArgs]
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    records_src str
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    name String
    Name of the datagroup
    type String
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    internal Boolean
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    records List<Property Map>
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    recordsSrc String
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DataGroup 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.

    Look up Existing DataGroup Resource

    Get an existing DataGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DataGroupState, opts?: CustomResourceOptions): DataGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            internal: Optional[bool] = None,
            name: Optional[str] = None,
            records: Optional[Sequence[DataGroupRecordArgs]] = None,
            records_src: Optional[str] = None,
            type: Optional[str] = None) -> DataGroup
    func GetDataGroup(ctx *Context, name string, id IDInput, state *DataGroupState, opts ...ResourceOption) (*DataGroup, error)
    public static DataGroup Get(string name, Input<string> id, DataGroupState? state, CustomResourceOptions? opts = null)
    public static DataGroup get(String name, Output<String> id, DataGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Internal bool
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    Name string
    Name of the datagroup
    Records List<Pulumi.F5BigIP.Ltm.Inputs.DataGroupRecord>
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    RecordsSrc string
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    Type string
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    Internal bool
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    Name string
    Name of the datagroup
    Records []DataGroupRecordArgs
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    RecordsSrc string
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    Type string
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    internal Boolean
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    name String
    Name of the datagroup
    records List<DataGroupRecord>
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    recordsSrc String
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    type String
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    internal boolean
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    name string
    Name of the datagroup
    records DataGroupRecord[]
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    recordsSrc string
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    type string
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    internal bool
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    name str
    Name of the datagroup
    records Sequence[DataGroupRecordArgs]
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    records_src str
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    type str
    datagroup type (applies to the name field of the record), supports: string, ip or integer
    internal Boolean
    Set false if you want to Create External Datagroups. default is true,means creates internal datagroup.
    name String
    Name of the datagroup
    records List<Property Map>
    a set of name and data attributes, name must be of type specified by the type attributed (string, ip and integer), data is optional and can take any value, multiple record sets can be specified as needed.
    recordsSrc String
    Path to a file with records in it,The file should be well-formed,it includes records, one per line,that resemble the following format "key separator value". For example, foo := bar. This should be used in conjunction with internal attribute set false
    type String
    datagroup type (applies to the name field of the record), supports: string, ip or integer

    Supporting Types

    DataGroupRecord, DataGroupRecordArgs

    Name string
    , sets the value of the record's name attribute, must be of type defined in type attribute
    Data string
    , sets the value of the record's data attribute, specifying a value here will create a record in the form of name := data
    Name string
    , sets the value of the record's name attribute, must be of type defined in type attribute
    Data string
    , sets the value of the record's data attribute, specifying a value here will create a record in the form of name := data
    name String
    , sets the value of the record's name attribute, must be of type defined in type attribute
    data String
    , sets the value of the record's data attribute, specifying a value here will create a record in the form of name := data
    name string
    , sets the value of the record's name attribute, must be of type defined in type attribute
    data string
    , sets the value of the record's data attribute, specifying a value here will create a record in the form of name := data
    name str
    , sets the value of the record's name attribute, must be of type defined in type attribute
    data str
    , sets the value of the record's data attribute, specifying a value here will create a record in the form of name := data
    name String
    , sets the value of the record's name attribute, must be of type defined in type attribute
    data String
    , sets the value of the record's data attribute, specifying a value here will create a record in the form of name := data

    Package Details

    Repository
    f5 BIG-IP pulumi/pulumi-f5bigip
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the bigip Terraform Provider.
    f5bigip logo
    f5 BIG-IP v3.17.1 published on Friday, May 10, 2024 by Pulumi