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

f5bigip.ltm.CipherGroup

Explore with Pulumi AI

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

    f5bigip.ltm.CipherGroup Manages F5 BIG-IP LTM cipher group using iControl REST.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const test_cipher_group = new f5bigip.ltm.CipherGroup("test-cipher-group", {
        name: "/Common/test-cipher-group-01",
        allows: ["/Common/f5-aes"],
        requires: ["/Common/f5-quic"],
        ordering: "speed",
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    test_cipher_group = f5bigip.ltm.CipherGroup("test-cipher-group",
        name="/Common/test-cipher-group-01",
        allows=["/Common/f5-aes"],
        requires=["/Common/f5-quic"],
        ordering="speed")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-f5bigip/sdk/v3/go/f5bigip/ltm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ltm.NewCipherGroup(ctx, "test-cipher-group", &ltm.CipherGroupArgs{
    			Name: pulumi.String("/Common/test-cipher-group-01"),
    			Allows: pulumi.StringArray{
    				pulumi.String("/Common/f5-aes"),
    			},
    			Requires: pulumi.StringArray{
    				pulumi.String("/Common/f5-quic"),
    			},
    			Ordering: pulumi.String("speed"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using F5BigIP = Pulumi.F5BigIP;
    
    return await Deployment.RunAsync(() => 
    {
        var test_cipher_group = new F5BigIP.Ltm.CipherGroup("test-cipher-group", new()
        {
            Name = "/Common/test-cipher-group-01",
            Allows = new[]
            {
                "/Common/f5-aes",
            },
            Requires = new[]
            {
                "/Common/f5-quic",
            },
            Ordering = "speed",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.ltm.CipherGroup;
    import com.pulumi.f5bigip.ltm.CipherGroupArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var test_cipher_group = new CipherGroup("test-cipher-group", CipherGroupArgs.builder()        
                .name("/Common/test-cipher-group-01")
                .allows("/Common/f5-aes")
                .requires("/Common/f5-quic")
                .ordering("speed")
                .build());
    
        }
    }
    
    resources:
      test-cipher-group:
        type: f5bigip:ltm:CipherGroup
        properties:
          name: /Common/test-cipher-group-01
          allows:
            - /Common/f5-aes
          requires:
            - /Common/f5-quic
          ordering: speed
    

    Create CipherGroup Resource

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

    Constructor syntax

    new CipherGroup(name: string, args: CipherGroupArgs, opts?: CustomResourceOptions);
    @overload
    def CipherGroup(resource_name: str,
                    args: CipherGroupArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def CipherGroup(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    name: Optional[str] = None,
                    allows: Optional[Sequence[str]] = None,
                    description: Optional[str] = None,
                    ordering: Optional[str] = None,
                    requires: Optional[Sequence[str]] = None)
    func NewCipherGroup(ctx *Context, name string, args CipherGroupArgs, opts ...ResourceOption) (*CipherGroup, error)
    public CipherGroup(string name, CipherGroupArgs args, CustomResourceOptions? opts = null)
    public CipherGroup(String name, CipherGroupArgs args)
    public CipherGroup(String name, CipherGroupArgs args, CustomResourceOptions options)
    
    type: f5bigip:ltm:CipherGroup
    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 CipherGroupArgs
    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 CipherGroupArgs
    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 CipherGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CipherGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CipherGroupArgs
    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 cipherGroupResource = new F5BigIP.Ltm.CipherGroup("cipherGroupResource", new()
    {
        Name = "string",
        Allows = new[]
        {
            "string",
        },
        Description = "string",
        Ordering = "string",
        Requires = new[]
        {
            "string",
        },
    });
    
    example, err := ltm.NewCipherGroup(ctx, "cipherGroupResource", &ltm.CipherGroupArgs{
    	Name: pulumi.String("string"),
    	Allows: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Description: pulumi.String("string"),
    	Ordering:    pulumi.String("string"),
    	Requires: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var cipherGroupResource = new CipherGroup("cipherGroupResource", CipherGroupArgs.builder()
        .name("string")
        .allows("string")
        .description("string")
        .ordering("string")
        .requires("string")
        .build());
    
    cipher_group_resource = f5bigip.ltm.CipherGroup("cipherGroupResource",
        name="string",
        allows=["string"],
        description="string",
        ordering="string",
        requires=["string"])
    
    const cipherGroupResource = new f5bigip.ltm.CipherGroup("cipherGroupResource", {
        name: "string",
        allows: ["string"],
        description: "string",
        ordering: "string",
        requires: ["string"],
    });
    
    type: f5bigip:ltm:CipherGroup
    properties:
        allows:
            - string
        description: string
        name: string
        ordering: string
        requires:
            - string
    

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

    Name string
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    Allows List<string>
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    Description string
    Specifies descriptive text that identifies the cipher rule
    Ordering string
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    Requires List<string>
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    Name string
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    Allows []string
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    Description string
    Specifies descriptive text that identifies the cipher rule
    Ordering string
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    Requires []string
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    name String
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    allows List<String>
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    description String
    Specifies descriptive text that identifies the cipher rule
    ordering String
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    requires List<String>
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    name string
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    allows string[]
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    description string
    Specifies descriptive text that identifies the cipher rule
    ordering string
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    requires string[]
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    name str
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    allows Sequence[str]
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    description str
    Specifies descriptive text that identifies the cipher rule
    ordering str
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    requires Sequence[str]
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    name String
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    allows List<String>
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    description String
    Specifies descriptive text that identifies the cipher rule
    ordering String
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    requires List<String>
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].

    Outputs

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

    Get an existing CipherGroup 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?: CipherGroupState, opts?: CustomResourceOptions): CipherGroup
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            allows: Optional[Sequence[str]] = None,
            description: Optional[str] = None,
            name: Optional[str] = None,
            ordering: Optional[str] = None,
            requires: Optional[Sequence[str]] = None) -> CipherGroup
    func GetCipherGroup(ctx *Context, name string, id IDInput, state *CipherGroupState, opts ...ResourceOption) (*CipherGroup, error)
    public static CipherGroup Get(string name, Input<string> id, CipherGroupState? state, CustomResourceOptions? opts = null)
    public static CipherGroup get(String name, Output<String> id, CipherGroupState 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:
    Allows List<string>
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    Description string
    Specifies descriptive text that identifies the cipher rule
    Name string
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    Ordering string
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    Requires List<string>
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    Allows []string
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    Description string
    Specifies descriptive text that identifies the cipher rule
    Name string
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    Ordering string
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    Requires []string
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    allows List<String>
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    description String
    Specifies descriptive text that identifies the cipher rule
    name String
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    ordering String
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    requires List<String>
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    allows string[]
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    description string
    Specifies descriptive text that identifies the cipher rule
    name string
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    ordering string
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    requires string[]
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    allows Sequence[str]
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    description str
    Specifies descriptive text that identifies the cipher rule
    name str
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    ordering str
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    requires Sequence[str]
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].
    allows List<String>
    Specifies the configuration of the allowed groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no allowed ciphers, omit this attribute in the config or set it to an empty set like, [].
    description String
    Specifies descriptive text that identifies the cipher rule
    name String
    Name of the Cipher group. Name should be in pattern partition + cipher_group_name
    ordering String
    Controls the order of the Cipher String list in the Cipher Audit section. Options are Default, Speed, Strength, FIPS, and Hardware. The rules are processed in the order listed. The default is default.
    requires List<String>
    Specifies the configuration of the restrict groups of ciphers. You can select a cipher rule from the Available Cipher Rules list. To have no restricted ciphers, omit this attribute in the config or set it to an empty set like, [].

    Import

    ing

    An existing cipher group can be imported into this resource by supplying the cipher rule full path name ex : /partition/name An example is below:

    $ terraform import bigip_ltm_cipher_group.test_cipher_group /Common/test_cipher_group
    

    To learn more about importing existing cloud resources, see Importing resources.

    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