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

f5bigip.ltm.CipherRule

Explore with Pulumi AI

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

    f5bigip.ltm.CipherRule Manages F5 BIG-IP LTM cipher rule using iControl REST.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as f5bigip from "@pulumi/f5bigip";
    
    const testCipherRule = new f5bigip.ltm.CipherRule("test_cipher_rule", {
        name: "/Common/test_cipher_rule",
        cipher: "TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384",
        dhGroups: "P256:P384:FFDHE2048:FFDHE3072:FFDHE4096",
        signatureAlgorithms: "DEFAULT",
    });
    
    import pulumi
    import pulumi_f5bigip as f5bigip
    
    test_cipher_rule = f5bigip.ltm.CipherRule("test_cipher_rule",
        name="/Common/test_cipher_rule",
        cipher="TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384",
        dh_groups="P256:P384:FFDHE2048:FFDHE3072:FFDHE4096",
        signature_algorithms="DEFAULT")
    
    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.NewCipherRule(ctx, "test_cipher_rule", &ltm.CipherRuleArgs{
    			Name:                pulumi.String("/Common/test_cipher_rule"),
    			Cipher:              pulumi.String("TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384"),
    			DhGroups:            pulumi.String("P256:P384:FFDHE2048:FFDHE3072:FFDHE4096"),
    			SignatureAlgorithms: pulumi.String("DEFAULT"),
    		})
    		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 testCipherRule = new F5BigIP.Ltm.CipherRule("test_cipher_rule", new()
        {
            Name = "/Common/test_cipher_rule",
            Cipher = "TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384",
            DhGroups = "P256:P384:FFDHE2048:FFDHE3072:FFDHE4096",
            SignatureAlgorithms = "DEFAULT",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.f5bigip.ltm.CipherRule;
    import com.pulumi.f5bigip.ltm.CipherRuleArgs;
    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 testCipherRule = new CipherRule("testCipherRule", CipherRuleArgs.builder()        
                .name("/Common/test_cipher_rule")
                .cipher("TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384")
                .dhGroups("P256:P384:FFDHE2048:FFDHE3072:FFDHE4096")
                .signatureAlgorithms("DEFAULT")
                .build());
    
        }
    }
    
    resources:
      testCipherRule:
        type: f5bigip:ltm:CipherRule
        name: test_cipher_rule
        properties:
          name: /Common/test_cipher_rule
          cipher: TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384
          dhGroups: P256:P384:FFDHE2048:FFDHE3072:FFDHE4096
          signatureAlgorithms: DEFAULT
    

    Create CipherRule Resource

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

    Constructor syntax

    new CipherRule(name: string, args: CipherRuleArgs, opts?: CustomResourceOptions);
    @overload
    def CipherRule(resource_name: str,
                   args: CipherRuleArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def CipherRule(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   cipher: Optional[str] = None,
                   name: Optional[str] = None,
                   description: Optional[str] = None,
                   dh_groups: Optional[str] = None,
                   signature_algorithms: Optional[str] = None)
    func NewCipherRule(ctx *Context, name string, args CipherRuleArgs, opts ...ResourceOption) (*CipherRule, error)
    public CipherRule(string name, CipherRuleArgs args, CustomResourceOptions? opts = null)
    public CipherRule(String name, CipherRuleArgs args)
    public CipherRule(String name, CipherRuleArgs args, CustomResourceOptions options)
    
    type: f5bigip:ltm:CipherRule
    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 CipherRuleArgs
    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 CipherRuleArgs
    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 CipherRuleArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args CipherRuleArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args CipherRuleArgs
    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 cipherRuleResource = new F5BigIP.Ltm.CipherRule("cipherRuleResource", new()
    {
        Cipher = "string",
        Name = "string",
        Description = "string",
        DhGroups = "string",
        SignatureAlgorithms = "string",
    });
    
    example, err := ltm.NewCipherRule(ctx, "cipherRuleResource", &ltm.CipherRuleArgs{
    	Cipher:              pulumi.String("string"),
    	Name:                pulumi.String("string"),
    	Description:         pulumi.String("string"),
    	DhGroups:            pulumi.String("string"),
    	SignatureAlgorithms: pulumi.String("string"),
    })
    
    var cipherRuleResource = new CipherRule("cipherRuleResource", CipherRuleArgs.builder()
        .cipher("string")
        .name("string")
        .description("string")
        .dhGroups("string")
        .signatureAlgorithms("string")
        .build());
    
    cipher_rule_resource = f5bigip.ltm.CipherRule("cipherRuleResource",
        cipher="string",
        name="string",
        description="string",
        dh_groups="string",
        signature_algorithms="string")
    
    const cipherRuleResource = new f5bigip.ltm.CipherRule("cipherRuleResource", {
        cipher: "string",
        name: "string",
        description: "string",
        dhGroups: "string",
        signatureAlgorithms: "string",
    });
    
    type: f5bigip:ltm:CipherRule
    properties:
        cipher: string
        description: string
        dhGroups: string
        name: string
        signatureAlgorithms: string
    

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

    Cipher string
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    Name string
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    Description string
    The Partition in which the Cipher Rule will be created.
    DhGroups string
    Specifies the DH Groups algorithms, separated by colons (:).
    SignatureAlgorithms string
    Specifies the Signature Algorithms, separated by colons (:).
    Cipher string
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    Name string
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    Description string
    The Partition in which the Cipher Rule will be created.
    DhGroups string
    Specifies the DH Groups algorithms, separated by colons (:).
    SignatureAlgorithms string
    Specifies the Signature Algorithms, separated by colons (:).
    cipher String
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    name String
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    description String
    The Partition in which the Cipher Rule will be created.
    dhGroups String
    Specifies the DH Groups algorithms, separated by colons (:).
    signatureAlgorithms String
    Specifies the Signature Algorithms, separated by colons (:).
    cipher string
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    name string
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    description string
    The Partition in which the Cipher Rule will be created.
    dhGroups string
    Specifies the DH Groups algorithms, separated by colons (:).
    signatureAlgorithms string
    Specifies the Signature Algorithms, separated by colons (:).
    cipher str
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    name str
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    description str
    The Partition in which the Cipher Rule will be created.
    dh_groups str
    Specifies the DH Groups algorithms, separated by colons (:).
    signature_algorithms str
    Specifies the Signature Algorithms, separated by colons (:).
    cipher String
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    name String
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    description String
    The Partition in which the Cipher Rule will be created.
    dhGroups String
    Specifies the DH Groups algorithms, separated by colons (:).
    signatureAlgorithms String
    Specifies the Signature Algorithms, separated by colons (:).

    Outputs

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

    Get an existing CipherRule 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?: CipherRuleState, opts?: CustomResourceOptions): CipherRule
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            cipher: Optional[str] = None,
            description: Optional[str] = None,
            dh_groups: Optional[str] = None,
            name: Optional[str] = None,
            signature_algorithms: Optional[str] = None) -> CipherRule
    func GetCipherRule(ctx *Context, name string, id IDInput, state *CipherRuleState, opts ...ResourceOption) (*CipherRule, error)
    public static CipherRule Get(string name, Input<string> id, CipherRuleState? state, CustomResourceOptions? opts = null)
    public static CipherRule get(String name, Output<String> id, CipherRuleState 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:
    Cipher string
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    Description string
    The Partition in which the Cipher Rule will be created.
    DhGroups string
    Specifies the DH Groups algorithms, separated by colons (:).
    Name string
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    SignatureAlgorithms string
    Specifies the Signature Algorithms, separated by colons (:).
    Cipher string
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    Description string
    The Partition in which the Cipher Rule will be created.
    DhGroups string
    Specifies the DH Groups algorithms, separated by colons (:).
    Name string
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    SignatureAlgorithms string
    Specifies the Signature Algorithms, separated by colons (:).
    cipher String
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    description String
    The Partition in which the Cipher Rule will be created.
    dhGroups String
    Specifies the DH Groups algorithms, separated by colons (:).
    name String
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    signatureAlgorithms String
    Specifies the Signature Algorithms, separated by colons (:).
    cipher string
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    description string
    The Partition in which the Cipher Rule will be created.
    dhGroups string
    Specifies the DH Groups algorithms, separated by colons (:).
    name string
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    signatureAlgorithms string
    Specifies the Signature Algorithms, separated by colons (:).
    cipher str
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    description str
    The Partition in which the Cipher Rule will be created.
    dh_groups str
    Specifies the DH Groups algorithms, separated by colons (:).
    name str
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    signature_algorithms str
    Specifies the Signature Algorithms, separated by colons (:).
    cipher String
    Specifies one or more Cipher Suites used,this is a colon (:) separated string of cipher suites. example, TLS13-AES128-GCM-SHA256:TLS13-AES256-GCM-SHA384.
    description String
    The Partition in which the Cipher Rule will be created.
    dhGroups String
    Specifies the DH Groups algorithms, separated by colons (:).
    name String
    Name of the Cipher Rule. Name should be in pattern partition + cipher_rule_name
    signatureAlgorithms String
    Specifies the Signature Algorithms, separated by colons (:).

    Import

    ing

    An existing cipher rule 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_rule.test_cipher_rule /Common/test_cipher_rule
    

    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