VaultMappedSecret

class oci.network_firewall.models.VaultMappedSecret(**kwargs)

Bases: MappedSecret

Mapped secret stored in OCI vault used in the firewall policy rules.

Attributes:

SOURCE_OCI_VAULT

A constant which can be used with the source property of a MappedSecret.

TYPE_SSL_FORWARD_PROXY

A constant which can be used with the type property of a MappedSecret.

TYPE_SSL_INBOUND_INSPECTION

A constant which can be used with the type property of a MappedSecret.

description

Gets the description of this MappedSecret.

name

[Required] Gets the name of this MappedSecret.

parent_resource_id

[Required] Gets the parent_resource_id of this MappedSecret.

source

[Required] Gets the source of this MappedSecret.

type

[Required] Gets the type of this MappedSecret.

vault_secret_id

[Required] Gets the vault_secret_id of this VaultMappedSecret.

version_number

[Required] Gets the version_number of this VaultMappedSecret.

Methods:

__init__(**kwargs)

Initializes a new VaultMappedSecret object with values from keyword arguments.

get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

SOURCE_OCI_VAULT = 'OCI_VAULT'

A constant which can be used with the source property of a MappedSecret. This constant has a value of “OCI_VAULT”

TYPE_SSL_FORWARD_PROXY = 'SSL_FORWARD_PROXY'

A constant which can be used with the type property of a MappedSecret. This constant has a value of “SSL_FORWARD_PROXY”

TYPE_SSL_INBOUND_INSPECTION = 'SSL_INBOUND_INSPECTION'

A constant which can be used with the type property of a MappedSecret. This constant has a value of “SSL_INBOUND_INSPECTION”

__init__(**kwargs)

Initializes a new VaultMappedSecret object with values from keyword arguments. The default value of the source attribute of this class is OCI_VAULT and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • name (str) – The value to assign to the name property of this VaultMappedSecret.

  • source (str) – The value to assign to the source property of this VaultMappedSecret. Allowed values for this property are: “OCI_VAULT”

  • type (str) – The value to assign to the type property of this VaultMappedSecret. Allowed values for this property are: “SSL_INBOUND_INSPECTION”, “SSL_FORWARD_PROXY”

  • parent_resource_id (str) – The value to assign to the parent_resource_id property of this VaultMappedSecret.

  • description (str) – The value to assign to the description property of this VaultMappedSecret.

  • vault_secret_id (str) – The value to assign to the vault_secret_id property of this VaultMappedSecret.

  • version_number (int) – The value to assign to the version_number property of this VaultMappedSecret.

property description

Gets the description of this MappedSecret. The description of the mapped secret. This field can be used to add additional info.

Returns

The description of this MappedSecret.

Return type

str

static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

property name

[Required] Gets the name of this MappedSecret. Name of the secret.

Returns

The name of this MappedSecret.

Return type

str

property parent_resource_id

[Required] Gets the parent_resource_id of this MappedSecret. OCID of the Network Firewall Policy this Mapped Secret belongs to.

Returns

The parent_resource_id of this MappedSecret.

Return type

str

property source

[Required] Gets the source of this MappedSecret. Source of the secrets, where the secrets are stored.

Allowed values for this property are: “OCI_VAULT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The source of this MappedSecret.

Return type

str

property type

[Required] Gets the type of this MappedSecret. Type of the secrets mapped based on the policy.

  • SSL_INBOUND_INSPECTION: For Inbound inspection of SSL traffic.

  • SSL_FORWARD_PROXY: For forward proxy certificates for SSL inspection.

Allowed values for this property are: “SSL_INBOUND_INSPECTION”, “SSL_FORWARD_PROXY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The type of this MappedSecret.

Return type

str

property vault_secret_id

[Required] Gets the vault_secret_id of this VaultMappedSecret. OCID for the Vault Secret to be used.

Returns

The vault_secret_id of this VaultMappedSecret.

Return type

str

property version_number

[Required] Gets the version_number of this VaultMappedSecret. Version number of the secret to be used.

Returns

The version_number of this VaultMappedSecret.

Return type

int