f5xc_code_base_integration Resource - terraform-provider-f5xc

f5xc_code_base_integration (Resource)

Manages integration details. in F5 Distributed Cloud.

~> Note For more information about this resource, please refer to the F5 XC API Documentation.

Example Usage

# codebase Integration Resource Example
# Manages integration details. in F5 Distributed Cloud.

terraform {
  required_version = ">= 1.0"

  required_providers {
    f5xc = {
      source  = "f5xc-salesdemos/f5xc"
      version = ">= 0.1.0"
    }
  }
}

# Basic codebase Integration configuration
resource "f5xc_code_base_integration" "example" {
  name      = "example-code-base-integration"
  namespace = "staging"

  labels = {
    environment = "production"
    managed_by  = "terraform"
  }

  annotations = {
    "owner" = "platform-team"
  }

  # Resource-specific configuration
  # Choose your codebase (e.g. GitHub, GitLab, Bitbucket, Az...
  code_base_integration {
    # Configure code_base_integration settings
  }
  # Configuration parameter for Azure repos.
  azure_repos {
    # Configure azure_repos settings
  }
  # SecretType is used in an object to indicate a sensitive/c...
  access_token {
    # Configure access_token settings
  }
}

Argument Reference

🔶 High Risk Operations — Some operations on this resource have high danger level. Destructive operations may require confirmation.

Metadata Argument Reference

• name - Required String
Name of the codebase Integration. Must be unique within the namespace

• namespace - Required String
Namespace where the codebase Integration will be created

• annotations - Optional Map
Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata

• description - Optional String
Human readable description for the object

• disable - Optional Bool
A value of true will administratively disable the object

• labels - Optional Map
Labels is a user defined key value map that can be attached to resources for organization and filtering

Spec Argument Reference

• code_base_integration - Optional Block
Choose your codebase (e.g. GitHub, GitLab, Bitbucket, Azure) and provide credentials and connection details
See codebase Integration below for details.

• timeouts - Optional Block
See Timeouts below for details.

Attributes Reference

In addition to all arguments above, the following attributes are exported:

• id - Optional String
Unique identifier for the resource

codebase Integration

A code_base_integration block supports the following:

• azure_repos - Optional Block
Configuration parameter for Azure repos
See Azure Repos below.

• Bitbucket - Optional Block
Bitbucket Cloud Integration
See Bitbucket below.

• bitbucket_server - Optional Block
Configuration parameter for Bitbucket server
See Bitbucket Server below.

• GitHub - Optional Block
GitHub Integration
See GitHub below.

• github_enterprise - Optional Block
Configuration parameter for GitHub enterprise
See GitHub Enterprise below.

• GitLab - Optional Block
GitLab Cloud Integration
See GitLab below.

• gitlab_enterprise - Optional Block
Configuration parameter for GitLab enterprise
See GitLab Enterprise below.

codebase Integration Azure Repos

An azure_repos block (within code_base_integration) supports the following:

• access_token - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Access Token below.

codebase Integration Azure Repos Access Token

An access_token block (within code_base_integration.azure_repos) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

codebase Integration Azure Repos Access Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration Azure Repos Access Token Clear Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration Bitbucket

A Bitbucket block (within code_base_integration) supports the following:

• passwd - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Passwd below.

• username - Optional String
Bitbucket Username

codebase Integration Bitbucket Passwd

A passwd block (within code_base_integration.Bitbucket) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

codebase Integration Bitbucket Passwd Blindfold Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration Bitbucket Passwd Clear Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration Bitbucket Server

A bitbucket_server block (within code_base_integration) supports the following:

• passwd - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Passwd below.

• url - Optional String
Bitbucket Server URL

• username - Optional String
Bitbucket Server Username

• verify_ssl - Optional Bool
Verify SSL. Configuration parameter for verify SSL

codebase Integration Bitbucket Server Passwd

A passwd block (within code_base_integration.bitbucket_server) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

codebase Integration Bitbucket Server Passwd Blindfold Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration Bitbucket Server Passwd Clear Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration GitHub

A GitHub block (within code_base_integration) supports the following:

• access_token - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Access Token below.

• username - Optional String
GitHub Username

• verify_ssl - Optional Bool
GitHub Verify SSL. Configuration parameter for verify SSL

codebase Integration GitHub Access Token

An access_token block (within code_base_integration.GitHub) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

codebase Integration GitHub Access Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration GitHub Access Token Clear Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration GitHub Enterprise

A github_enterprise block (within code_base_integration) supports the following:

• access_token - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Access Token below.

• hostname - Optional String
GitHub Hostname

• username - Optional String
GitHub Username

codebase Integration GitHub Enterprise Access Token

An access_token block (within code_base_integration.github_enterprise) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

codebase Integration GitHub Enterprise Access Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration GitHub Enterprise Access Token Clear Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration GitLab

A GitLab block (within code_base_integration) supports the following:

• access_token - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Access Token below.

codebase Integration GitLab Access Token

An access_token block (within code_base_integration.GitLab) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

codebase Integration GitLab Access Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration GitLab Access Token Clear Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration GitLab Enterprise

A gitlab_enterprise block (within code_base_integration) supports the following:

• access_token - Optional Block
SecretType is used in an object to indicate a sensitive/confidential field
See Access Token below.

• url - Optional String
GitLab URL

codebase Integration GitLab Enterprise Access Token

An access_token block (within code_base_integration.gitlab_enterprise) supports the following:

• blindfold_secret_info - Optional Block
BlindfoldSecretInfoType specifies information about the Secret managed by F5XC Secret Management
See Blindfold Secret Info below.

• clear_secret_info - Optional Block
ClearSecretInfoType specifies information about the Secret that is not encrypted
See Clear Secret Info below.

codebase Integration GitLab Enterprise Access Token Blindfold Secret Info

Deeply nested Info block collapsed for readability.

codebase Integration GitLab Enterprise Access Token Clear Secret Info

Deeply nested Info block collapsed for readability.

Timeouts

A timeouts block supports the following:

• create - Optional String (Defaults to 10 minutes)
Used when creating the resource

• delete - Optional String (Defaults to 10 minutes)
Used when deleting the resource

• read - Optional String (Defaults to 5 minutes)
Used when retrieving the resource

• update - Optional String (Defaults to 10 minutes)
Used when updating the resource

Common Types

The following type definitions are used throughout this resource. See the full definition here rather than repeated inline.

Object Reference {#common-object-reference}

Object references establish a direct reference from one configuration object to another in F5 Distributed Cloud. References use the format tenant/namespace/name.

Field	Type	Description
`name`	String	Name of the referenced object
`namespace`	String	Namespace containing the referenced object
`tenant`	String	Tenant of the referenced object (system-managed)

Transformers {#common-transformers}

Transformers apply transformations to input values before matching. Multiple transformers can be applied in order.

Value	Description
`LOWER_CASE`	Convert to lowercase
`UPPER_CASE`	Convert to uppercase
`BASE64_DECODE`	Decodebase64 content
`NORMALIZE_PATH`	Normalize URL path
`REMOVE_WHITESPACE`	Remove whitespace characters
`URL_DECODE`	Decode URL-encoded characters
`TRIM_LEFT`	Trim leading whitespace
`TRIM_RIGHT`	Trim trailing whitespace
`TRIM`	Trim both leading and trailing whitespace

HTTP Methods {#common-http-methods}

HTTP methods used for request matching.

Value	Description
`ANY`	Match any HTTP method
`GET`	HTTP GET request
`HEAD`	HTTP HEAD request
`POST`	HTTP POST request
`PUT`	HTTP PUT request
`DELETE`	HTTP DELETE request
`CONNECT`	HTTP CONNECT request
`OPTIONS`	HTTP OPTIONS request
`TRACE`	HTTP TRACE request
`PATCH`	HTTP PATCH request
`COPY`	HTTP COPY request (WebDAV)

TLS Fingerprints {#common-tls-fingerprints}

TLS fingerprint categories for malicious client detection.

Value	Description
`TLS_FINGERPRINT_NONE`	No fingerprint matching
`ANY_MALICIOUS_FINGERPRINT`	Match any known malicious fingerprint
`ADWARE`	Adware-associated fingerprints
`DRIDEX`	Dridex malware fingerprints
`GOOTKIT`	Gootkit malware fingerprints
`RANSOMWARE`	Ransomware-associated fingerprints
`TRICKBOT`	Trickbot malware fingerprints

IP Threat Categories {#common-ip-threat-categories}

IP address threat categories for security filtering.

Value	Description
`SPAM_SOURCES`	Known spam sources
`WINDOWS_EXPLOITS`	Windows exploit sources
`WEB_ATTACKS`	Web attack sources
`BOTNETS`	Known botnet IPs
`SCANNERS`	Network scanner IPs
`REPUTATION`	Poor reputation IPs
`PHISHING`	Phishing-related IPs
`PROXY`	Anonymous proxy IPs
`MOBILE_THREATS`	Mobile threat sources
`TOR_PROXY`	Tor exit nodes
`DENIAL_OF_SERVICE`	DoS attack sources
`NETWORK`	Known bad network ranges

Import

Import is supported using the following syntax:

# Import using namespace/name format
terraform import f5xc_code_base_integration.example system/example