Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. F5bigip Provider
  3. API Docs
  4. SaasBotDefenseProfile
f5 BIG-IP v3.17.9 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-f5bigip

f5bigip.SaasBotDefenseProfile

Explore with Pulumi AI

f5bigip logo
f5 BIG-IP v3.17.9 published on Friday, Mar 7, 2025 by Pulumi
pulumi/pulumi-f5bigip

    Create SaasBotDefenseProfile Resource

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

    Constructor syntax

    new SaasBotDefenseProfile(name: string, args: SaasBotDefenseProfileArgs, opts?: CustomResourceOptions);
    @overload
def SaasBotDefenseProfile(resource_name: str,
                          args: SaasBotDefenseProfileArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def SaasBotDefenseProfile(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          api_key: Optional[str] = None,
                          application_id: Optional[str] = None,
                          name: Optional[str] = None,
                          protected_endpoints: Optional[Sequence[SaasBotDefenseProfileProtectedEndpointArgs]] = None,
                          shape_protection_pool: Optional[str] = None,
                          ssl_profile: Optional[str] = None,
                          tenant_id: Optional[str] = None,
                          defaults_from: Optional[str] = None,
                          description: Optional[str] = None)
    func NewSaasBotDefenseProfile(ctx *Context, name string, args SaasBotDefenseProfileArgs, opts ...ResourceOption) (*SaasBotDefenseProfile, error)
    public SaasBotDefenseProfile(string name, SaasBotDefenseProfileArgs args, CustomResourceOptions? opts = null)
    public SaasBotDefenseProfile(String name, SaasBotDefenseProfileArgs args)
public SaasBotDefenseProfile(String name, SaasBotDefenseProfileArgs args, CustomResourceOptions options)

    type: f5bigip:SaasBotDefenseProfile
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 SaasBotDefenseProfileArgs
    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 SaasBotDefenseProfileArgs
    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 SaasBotDefenseProfileArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SaasBotDefenseProfileArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SaasBotDefenseProfileArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var saasBotDefenseProfileResource = new F5BigIP.SaasBotDefenseProfile("saasBotDefenseProfileResource", new()
{
    ApiKey = "string",
    ApplicationId = "string",
    Name = "string",
    ProtectedEndpoints = new[]
    {
        new F5BigIP.Inputs.SaasBotDefenseProfileProtectedEndpointArgs
        {
            Name = "string",
            Endpoint = "string",
            Host = "string",
            MitigationAction = "string",
            Post = "string",
            Put = "string",
        },
    },
    ShapeProtectionPool = "string",
    SslProfile = "string",
    TenantId = "string",
    DefaultsFrom = "string",
    Description = "string",
});

    example, err := f5bigip.NewSaasBotDefenseProfile(ctx, "saasBotDefenseProfileResource", &f5bigip.SaasBotDefenseProfileArgs{
	ApiKey:        pulumi.String("string"),
	ApplicationId: pulumi.String("string"),
	Name:          pulumi.String("string"),
	ProtectedEndpoints: f5bigip.SaasBotDefenseProfileProtectedEndpointArray{
		&f5bigip.SaasBotDefenseProfileProtectedEndpointArgs{
			Name:             pulumi.String("string"),
			Endpoint:         pulumi.String("string"),
			Host:             pulumi.String("string"),
			MitigationAction: pulumi.String("string"),
			Post:             pulumi.String("string"),
			Put:              pulumi.String("string"),
		},
	},
	ShapeProtectionPool: pulumi.String("string"),
	SslProfile:          pulumi.String("string"),
	TenantId:            pulumi.String("string"),
	DefaultsFrom:        pulumi.String("string"),
	Description:         pulumi.String("string"),
})

    var saasBotDefenseProfileResource = new SaasBotDefenseProfile("saasBotDefenseProfileResource", SaasBotDefenseProfileArgs.builder()
    .apiKey("string")
    .applicationId("string")
    .name("string")
    .protectedEndpoints(SaasBotDefenseProfileProtectedEndpointArgs.builder()
        .name("string")
        .endpoint("string")
        .host("string")
        .mitigationAction("string")
        .post("string")
        .put("string")
        .build())
    .shapeProtectionPool("string")
    .sslProfile("string")
    .tenantId("string")
    .defaultsFrom("string")
    .description("string")
    .build());

    saas_bot_defense_profile_resource = f5bigip.SaasBotDefenseProfile("saasBotDefenseProfileResource",
    api_key="string",
    application_id="string",
    name="string",
    protected_endpoints=[{
        "name": "string",
        "endpoint": "string",
        "host": "string",
        "mitigation_action": "string",
        "post": "string",
        "put": "string",
    }],
    shape_protection_pool="string",
    ssl_profile="string",
    tenant_id="string",
    defaults_from="string",
    description="string")

    const saasBotDefenseProfileResource = new f5bigip.SaasBotDefenseProfile("saasBotDefenseProfileResource", {
    apiKey: "string",
    applicationId: "string",
    name: "string",
    protectedEndpoints: [{
        name: "string",
        endpoint: "string",
        host: "string",
        mitigationAction: "string",
        post: "string",
        put: "string",
    }],
    shapeProtectionPool: "string",
    sslProfile: "string",
    tenantId: "string",
    defaultsFrom: "string",
    description: "string",
});

    type: f5bigip:SaasBotDefenseProfile
properties:
    apiKey: string
    applicationId: string
    defaultsFrom: string
    description: string
    name: string
    protectedEndpoints:
        - endpoint: string
          host: string
          mitigationAction: string
          name: string
          post: string
          put: string
    shapeProtectionPool: string
    sslProfile: string
    tenantId: string

    SaasBotDefenseProfile Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SaasBotDefenseProfile resource accepts the following input properties:

    ApiKey string
    Specifies the API key, enter the value provided by F5 Support.
    ApplicationId string
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    Name string
    Unique name for the Distributed Cloud Services Bot Defense profile
    ProtectedEndpoints List<Pulumi.F5BigIP.Inputs.SaasBotDefenseProfileProtectedEndpoint>
    Use these settings to configure which pages on the website will be protected by BD
    ShapeProtectionPool string
    Specifies the web hostname to which API requests are made
    SslProfile string
    Specifies a server-side SSL profile that is different from what the application pool uses
    TenantId string
    Specifies the tenant ID, enter the value provided by F5 Support
    DefaultsFrom string
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    Description string
    Specifies descriptive text that identifies the BD profile.
    ApiKey string
    Specifies the API key, enter the value provided by F5 Support.
    ApplicationId string
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    Name string
    Unique name for the Distributed Cloud Services Bot Defense profile
    ProtectedEndpoints []SaasBotDefenseProfileProtectedEndpointArgs
    Use these settings to configure which pages on the website will be protected by BD
    ShapeProtectionPool string
    Specifies the web hostname to which API requests are made
    SslProfile string
    Specifies a server-side SSL profile that is different from what the application pool uses
    TenantId string
    Specifies the tenant ID, enter the value provided by F5 Support
    DefaultsFrom string
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    Description string
    Specifies descriptive text that identifies the BD profile.
    apiKey String
    Specifies the API key, enter the value provided by F5 Support.
    applicationId String
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    name String
    Unique name for the Distributed Cloud Services Bot Defense profile
    protectedEndpoints List<SaasBotDefenseProfileProtectedEndpoint>
    Use these settings to configure which pages on the website will be protected by BD
    shapeProtectionPool String
    Specifies the web hostname to which API requests are made
    sslProfile String
    Specifies a server-side SSL profile that is different from what the application pool uses
    tenantId String
    Specifies the tenant ID, enter the value provided by F5 Support
    defaultsFrom String
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    description String
    Specifies descriptive text that identifies the BD profile.
    apiKey string
    Specifies the API key, enter the value provided by F5 Support.
    applicationId string
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    name string
    Unique name for the Distributed Cloud Services Bot Defense profile
    protectedEndpoints SaasBotDefenseProfileProtectedEndpoint[]
    Use these settings to configure which pages on the website will be protected by BD
    shapeProtectionPool string
    Specifies the web hostname to which API requests are made
    sslProfile string
    Specifies a server-side SSL profile that is different from what the application pool uses
    tenantId string
    Specifies the tenant ID, enter the value provided by F5 Support
    defaultsFrom string
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    description string
    Specifies descriptive text that identifies the BD profile.
    api_key str
    Specifies the API key, enter the value provided by F5 Support.
    application_id str
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    name str
    Unique name for the Distributed Cloud Services Bot Defense profile
    protected_endpoints Sequence[SaasBotDefenseProfileProtectedEndpointArgs]
    Use these settings to configure which pages on the website will be protected by BD
    shape_protection_pool str
    Specifies the web hostname to which API requests are made
    ssl_profile str
    Specifies a server-side SSL profile that is different from what the application pool uses
    tenant_id str
    Specifies the tenant ID, enter the value provided by F5 Support
    defaults_from str
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    description str
    Specifies descriptive text that identifies the BD profile.
    apiKey String
    Specifies the API key, enter the value provided by F5 Support.
    applicationId String
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    name String
    Unique name for the Distributed Cloud Services Bot Defense profile
    protectedEndpoints List<Property Map>
    Use these settings to configure which pages on the website will be protected by BD
    shapeProtectionPool String
    Specifies the web hostname to which API requests are made
    sslProfile String
    Specifies a server-side SSL profile that is different from what the application pool uses
    tenantId String
    Specifies the tenant ID, enter the value provided by F5 Support
    defaultsFrom String
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    description String
    Specifies descriptive text that identifies the BD profile.

    Outputs

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

    Get an existing SaasBotDefenseProfile 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?: SaasBotDefenseProfileState, opts?: CustomResourceOptions): SaasBotDefenseProfile
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_key: Optional[str] = None,
        application_id: Optional[str] = None,
        defaults_from: Optional[str] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        protected_endpoints: Optional[Sequence[SaasBotDefenseProfileProtectedEndpointArgs]] = None,
        shape_protection_pool: Optional[str] = None,
        ssl_profile: Optional[str] = None,
        tenant_id: Optional[str] = None) -> SaasBotDefenseProfile
    func GetSaasBotDefenseProfile(ctx *Context, name string, id IDInput, state *SaasBotDefenseProfileState, opts ...ResourceOption) (*SaasBotDefenseProfile, error)
    public static SaasBotDefenseProfile Get(string name, Input<string> id, SaasBotDefenseProfileState? state, CustomResourceOptions? opts = null)
    public static SaasBotDefenseProfile get(String name, Output<String> id, SaasBotDefenseProfileState state, CustomResourceOptions options)
    resources:  _:    type: f5bigip:SaasBotDefenseProfile    get:      id: ${id}
    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:
    ApiKey string
    Specifies the API key, enter the value provided by F5 Support.
    ApplicationId string
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    DefaultsFrom string
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    Description string
    Specifies descriptive text that identifies the BD profile.
    Name string
    Unique name for the Distributed Cloud Services Bot Defense profile
    ProtectedEndpoints List<Pulumi.F5BigIP.Inputs.SaasBotDefenseProfileProtectedEndpoint>
    Use these settings to configure which pages on the website will be protected by BD
    ShapeProtectionPool string
    Specifies the web hostname to which API requests are made
    SslProfile string
    Specifies a server-side SSL profile that is different from what the application pool uses
    TenantId string
    Specifies the tenant ID, enter the value provided by F5 Support
    ApiKey string
    Specifies the API key, enter the value provided by F5 Support.
    ApplicationId string
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    DefaultsFrom string
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    Description string
    Specifies descriptive text that identifies the BD profile.
    Name string
    Unique name for the Distributed Cloud Services Bot Defense profile
    ProtectedEndpoints []SaasBotDefenseProfileProtectedEndpointArgs
    Use these settings to configure which pages on the website will be protected by BD
    ShapeProtectionPool string
    Specifies the web hostname to which API requests are made
    SslProfile string
    Specifies a server-side SSL profile that is different from what the application pool uses
    TenantId string
    Specifies the tenant ID, enter the value provided by F5 Support
    apiKey String
    Specifies the API key, enter the value provided by F5 Support.
    applicationId String
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    defaultsFrom String
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    description String
    Specifies descriptive text that identifies the BD profile.
    name String
    Unique name for the Distributed Cloud Services Bot Defense profile
    protectedEndpoints List<SaasBotDefenseProfileProtectedEndpoint>
    Use these settings to configure which pages on the website will be protected by BD
    shapeProtectionPool String
    Specifies the web hostname to which API requests are made
    sslProfile String
    Specifies a server-side SSL profile that is different from what the application pool uses
    tenantId String
    Specifies the tenant ID, enter the value provided by F5 Support
    apiKey string
    Specifies the API key, enter the value provided by F5 Support.
    applicationId string
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    defaultsFrom string
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    description string
    Specifies descriptive text that identifies the BD profile.
    name string
    Unique name for the Distributed Cloud Services Bot Defense profile
    protectedEndpoints SaasBotDefenseProfileProtectedEndpoint[]
    Use these settings to configure which pages on the website will be protected by BD
    shapeProtectionPool string
    Specifies the web hostname to which API requests are made
    sslProfile string
    Specifies a server-side SSL profile that is different from what the application pool uses
    tenantId string
    Specifies the tenant ID, enter the value provided by F5 Support
    api_key str
    Specifies the API key, enter the value provided by F5 Support.
    application_id str
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    defaults_from str
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    description str
    Specifies descriptive text that identifies the BD profile.
    name str
    Unique name for the Distributed Cloud Services Bot Defense profile
    protected_endpoints Sequence[SaasBotDefenseProfileProtectedEndpointArgs]
    Use these settings to configure which pages on the website will be protected by BD
    shape_protection_pool str
    Specifies the web hostname to which API requests are made
    ssl_profile str
    Specifies a server-side SSL profile that is different from what the application pool uses
    tenant_id str
    Specifies the tenant ID, enter the value provided by F5 Support
    apiKey String
    Specifies the API key, enter the value provided by F5 Support.
    applicationId String
    Specifies the Bot Defense API application ID, enter the value provided by F5 Support
    defaultsFrom String
    Distributed Cloud Services Bot Defense parent profile from which this profile will inherit settings.
    description String
    Specifies descriptive text that identifies the BD profile.
    name String
    Unique name for the Distributed Cloud Services Bot Defense profile
    protectedEndpoints List<Property Map>
    Use these settings to configure which pages on the website will be protected by BD
    shapeProtectionPool String
    Specifies the web hostname to which API requests are made
    sslProfile String
    Specifies a server-side SSL profile that is different from what the application pool uses
    tenantId String
    Specifies the tenant ID, enter the value provided by F5 Support

    Supporting Types

    SaasBotDefenseProfileProtectedEndpoint, SaasBotDefenseProfileProtectedEndpointArgs

    Name string
    Unique name for the protected endpoint
    Endpoint string
    Specifies the path to the web page to be protected by BD. For example, /login.
    Host string
    hostname or IP address of the web page to be protected by the Bot Defense
    MitigationAction string
    Specifies whether the BIG-IP or F5 XC Bot Defense handles mitigation of malicious HTTP requests. This field is enabled only if the Service Level field is set to Advanced/Premium
    Post string
    POST field to protect the path when it has a POST method, enabled or disabled
    Put string
    PUT field to protect the path when it has a PUT method,enabled or disabled
    Name string
    Unique name for the protected endpoint
    Endpoint string
    Specifies the path to the web page to be protected by BD. For example, /login.
    Host string
    hostname or IP address of the web page to be protected by the Bot Defense
    MitigationAction string
    Specifies whether the BIG-IP or F5 XC Bot Defense handles mitigation of malicious HTTP requests. This field is enabled only if the Service Level field is set to Advanced/Premium
    Post string
    POST field to protect the path when it has a POST method, enabled or disabled
    Put string
    PUT field to protect the path when it has a PUT method,enabled or disabled
    name String
    Unique name for the protected endpoint
    endpoint String
    Specifies the path to the web page to be protected by BD. For example, /login.
    host String
    hostname or IP address of the web page to be protected by the Bot Defense
    mitigationAction String
    Specifies whether the BIG-IP or F5 XC Bot Defense handles mitigation of malicious HTTP requests. This field is enabled only if the Service Level field is set to Advanced/Premium
    post String
    POST field to protect the path when it has a POST method, enabled or disabled
    put String
    PUT field to protect the path when it has a PUT method,enabled or disabled
    name string
    Unique name for the protected endpoint
    endpoint string
    Specifies the path to the web page to be protected by BD. For example, /login.
    host string
    hostname or IP address of the web page to be protected by the Bot Defense
    mitigationAction string
    Specifies whether the BIG-IP or F5 XC Bot Defense handles mitigation of malicious HTTP requests. This field is enabled only if the Service Level field is set to Advanced/Premium
    post string
    POST field to protect the path when it has a POST method, enabled or disabled
    put string
    PUT field to protect the path when it has a PUT method,enabled or disabled
    name str
    Unique name for the protected endpoint
    endpoint str
    Specifies the path to the web page to be protected by BD. For example, /login.
    host str
    hostname or IP address of the web page to be protected by the Bot Defense
    mitigation_action str
    Specifies whether the BIG-IP or F5 XC Bot Defense handles mitigation of malicious HTTP requests. This field is enabled only if the Service Level field is set to Advanced/Premium
    post str
    POST field to protect the path when it has a POST method, enabled or disabled
    put str
    PUT field to protect the path when it has a PUT method,enabled or disabled
    name String
    Unique name for the protected endpoint
    endpoint String
    Specifies the path to the web page to be protected by BD. For example, /login.
    host String
    hostname or IP address of the web page to be protected by the Bot Defense
    mitigationAction String
    Specifies whether the BIG-IP or F5 XC Bot Defense handles mitigation of malicious HTTP requests. This field is enabled only if the Service Level field is set to Advanced/Premium
    post String
    POST field to protect the path when it has a POST method, enabled or disabled
    put String
    PUT field to protect the path when it has a PUT method,enabled or disabled

    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.9 published on Friday, Mar 7, 2025 by Pulumi
    pulumi/pulumi-f5bigip