TargetPing

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create TargetPing Resource

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

Constructor syntax

new TargetPing(name: string, args?: TargetPingArgs, opts?: CustomResourceOptions);

@overload
def TargetPing(resource_name: str,
               args: Optional[TargetPingArgs] = None,
               opts: Optional[ResourceOptions] = None)

@overload
def TargetPing(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               administrative_port: Optional[str] = None,
               authorization_port: Optional[str] = None,
               description: Optional[str] = None,
               keep_prev_version: Optional[str] = None,
               key: Optional[str] = None,
               max_versions: Optional[str] = None,
               name: Optional[str] = None,
               password: Optional[str] = None,
               ping_url: Optional[str] = None,
               privileged_user: Optional[str] = None,
               target_ping_id: Optional[str] = None)

func NewTargetPing(ctx *Context, name string, args *TargetPingArgs, opts ...ResourceOption) (*TargetPing, error)

public TargetPing(string name, TargetPingArgs? args = null, CustomResourceOptions? opts = null)

public TargetPing(String name, TargetPingArgs args)
public TargetPing(String name, TargetPingArgs args, CustomResourceOptions options)

type: akeyless:TargetPing
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 TargetPingArgs: 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 TargetPingArgs: 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 TargetPingArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TargetPingArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args TargetPingArgs: 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 targetPingResource = new Akeyless.TargetPing("targetPingResource", new()
{
    AdministrativePort = "string",
    AuthorizationPort = "string",
    Description = "string",
    KeepPrevVersion = "string",
    Key = "string",
    MaxVersions = "string",
    Name = "string",
    Password = "string",
    PingUrl = "string",
    PrivilegedUser = "string",
    TargetPingId = "string",
});

example, err := akeyless.NewTargetPing(ctx, "targetPingResource", &akeyless.TargetPingArgs{
	AdministrativePort: pulumi.String("string"),
	AuthorizationPort:  pulumi.String("string"),
	Description:        pulumi.String("string"),
	KeepPrevVersion:    pulumi.String("string"),
	Key:                pulumi.String("string"),
	MaxVersions:        pulumi.String("string"),
	Name:               pulumi.String("string"),
	Password:           pulumi.String("string"),
	PingUrl:            pulumi.String("string"),
	PrivilegedUser:     pulumi.String("string"),
	TargetPingId:       pulumi.String("string"),
})

var targetPingResource = new TargetPing("targetPingResource", TargetPingArgs.builder()
    .administrativePort("string")
    .authorizationPort("string")
    .description("string")
    .keepPrevVersion("string")
    .key("string")
    .maxVersions("string")
    .name("string")
    .password("string")
    .pingUrl("string")
    .privilegedUser("string")
    .targetPingId("string")
    .build());

target_ping_resource = akeyless.TargetPing("targetPingResource",
    administrative_port="string",
    authorization_port="string",
    description="string",
    keep_prev_version="string",
    key="string",
    max_versions="string",
    name="string",
    password="string",
    ping_url="string",
    privileged_user="string",
    target_ping_id="string")

const targetPingResource = new akeyless.TargetPing("targetPingResource", {
    administrativePort: "string",
    authorizationPort: "string",
    description: "string",
    keepPrevVersion: "string",
    key: "string",
    maxVersions: "string",
    name: "string",
    password: "string",
    pingUrl: "string",
    privilegedUser: "string",
    targetPingId: "string",
});

type: akeyless:TargetPing
properties:
    administrativePort: string
    authorizationPort: string
    description: string
    keepPrevVersion: string
    key: string
    maxVersions: string
    name: string
    password: string
    pingUrl: string
    privilegedUser: string
    targetPingId: string

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

AdministrativePort string: Ping Federate administrative port
AuthorizationPort string: Ping Federate authorization port
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults
Name string: Target name
Password string: Ping Federate privileged user password
PingUrl string: Ping URL
PrivilegedUser string: Ping Federate privileged user
TargetPingId string: The ID of this resource.

AdministrativePort string: Ping Federate administrative port
AuthorizationPort string: Ping Federate authorization port
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults
Name string: Target name
Password string: Ping Federate privileged user password
PingUrl string: Ping URL
PrivilegedUser string: Ping Federate privileged user
TargetPingId string: The ID of this resource.

administrativePort String: Ping Federate administrative port
authorizationPort String: Ping Federate authorization port
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
maxVersions String: Set the maximum number of versions, limited by the account settings defaults
name String: Target name
password String: Ping Federate privileged user password
pingUrl String: Ping URL
privilegedUser String: Ping Federate privileged user
targetPingId String: The ID of this resource.

administrativePort string: Ping Federate administrative port
authorizationPort string: Ping Federate authorization port
description string: Description of the object
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
maxVersions string: Set the maximum number of versions, limited by the account settings defaults
name string: Target name
password string: Ping Federate privileged user password
pingUrl string: Ping URL
privilegedUser string: Ping Federate privileged user
targetPingId string: The ID of this resource.

administrative_port str: Ping Federate administrative port
authorization_port str: Ping Federate authorization port
description str: Description of the object
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
max_versions str: Set the maximum number of versions, limited by the account settings defaults
name str: Target name
password str: Ping Federate privileged user password
ping_url str: Ping URL
privileged_user str: Ping Federate privileged user
target_ping_id str: The ID of this resource.

administrativePort String: Ping Federate administrative port
authorizationPort String: Ping Federate authorization port
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
maxVersions String: Set the maximum number of versions, limited by the account settings defaults
name String: Target name
password String: Ping Federate privileged user password
pingUrl String: Ping URL
privilegedUser String: Ping Federate privileged user
targetPingId String: The ID of this resource.

Outputs

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

Get an existing TargetPing 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?: TargetPingState, opts?: CustomResourceOptions): TargetPing

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        administrative_port: Optional[str] = None,
        authorization_port: Optional[str] = None,
        description: Optional[str] = None,
        keep_prev_version: Optional[str] = None,
        key: Optional[str] = None,
        max_versions: Optional[str] = None,
        name: Optional[str] = None,
        password: Optional[str] = None,
        ping_url: Optional[str] = None,
        privileged_user: Optional[str] = None,
        target_ping_id: Optional[str] = None) -> TargetPing

func GetTargetPing(ctx *Context, name string, id IDInput, state *TargetPingState, opts ...ResourceOption) (*TargetPing, error)

public static TargetPing Get(string name, Input<string> id, TargetPingState? state, CustomResourceOptions? opts = null)

public static TargetPing get(String name, Output<String> id, TargetPingState state, CustomResourceOptions options)

resources:  _:    type: akeyless:TargetPing    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:

AdministrativePort string: Ping Federate administrative port
AuthorizationPort string: Ping Federate authorization port
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults
Name string: Target name
Password string: Ping Federate privileged user password
PingUrl string: Ping URL
PrivilegedUser string: Ping Federate privileged user
TargetPingId string: The ID of this resource.

AdministrativePort string: Ping Federate administrative port
AuthorizationPort string: Ping Federate authorization port
Description string: Description of the object
KeepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
Key string: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
MaxVersions string: Set the maximum number of versions, limited by the account settings defaults
Name string: Target name
Password string: Ping Federate privileged user password
PingUrl string: Ping URL
PrivilegedUser string: Ping Federate privileged user
TargetPingId string: The ID of this resource.

administrativePort String: Ping Federate administrative port
authorizationPort String: Ping Federate authorization port
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
maxVersions String: Set the maximum number of versions, limited by the account settings defaults
name String: Target name
password String: Ping Federate privileged user password
pingUrl String: Ping URL
privilegedUser String: Ping Federate privileged user
targetPingId String: The ID of this resource.

administrativePort string: Ping Federate administrative port
authorizationPort string: Ping Federate authorization port
description string: Description of the object
keepPrevVersion string: Whether to keep previous version [true/false]. If not set, use default according to account settings
key string: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
maxVersions string: Set the maximum number of versions, limited by the account settings defaults
name string: Target name
password string: Ping Federate privileged user password
pingUrl string: Ping URL
privilegedUser string: Ping Federate privileged user
targetPingId string: The ID of this resource.

administrative_port str: Ping Federate administrative port
authorization_port str: Ping Federate authorization port
description str: Description of the object
keep_prev_version str: Whether to keep previous version [true/false]. If not set, use default according to account settings
key str: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
max_versions str: Set the maximum number of versions, limited by the account settings defaults
name str: Target name
password str: Ping Federate privileged user password
ping_url str: Ping URL
privileged_user str: Ping Federate privileged user
target_ping_id str: The ID of this resource.

administrativePort String: Ping Federate administrative port
authorizationPort String: Ping Federate authorization port
description String: Description of the object
keepPrevVersion String: Whether to keep previous version [true/false]. If not set, use default according to account settings
key String: Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
maxVersions String: Set the maximum number of versions, limited by the account settings defaults
name String: Target name
password String: Ping Federate privileged user password
pingUrl String: Ping URL
privilegedUser String: Ping Federate privileged user
targetPingId String: The ID of this resource.