Dynatrace v0.21.0, Nov 17 24

Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse

dynatrace.ApiDetection

Explore with Pulumi AI

Dynatrace v0.21.0 published on Sunday, Nov 17, 2024 by Pulumiverse

Create ApiDetection Resource

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

Constructor syntax

new ApiDetection(name: string, args: ApiDetectionArgs, opts?: CustomResourceOptions);

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

@overload
def ApiDetection(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 api_color: Optional[str] = None,
                 api_name: Optional[str] = None,
                 third_party_api: Optional[bool] = None,
                 conditions: Optional[ApiDetectionConditionsArgs] = None,
                 insert_after: Optional[str] = None,
                 technology: Optional[str] = None)

func NewApiDetection(ctx *Context, name string, args ApiDetectionArgs, opts ...ResourceOption) (*ApiDetection, error)

public ApiDetection(string name, ApiDetectionArgs args, CustomResourceOptions? opts = null)

public ApiDetection(String name, ApiDetectionArgs args)
public ApiDetection(String name, ApiDetectionArgs args, CustomResourceOptions options)

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

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

name String: The unique name of the resource.
args ApiDetectionArgs: 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 apiDetectionResource = new Dynatrace.ApiDetection("apiDetectionResource", new()
{
    ApiColor = "string",
    ApiName = "string",
    ThirdPartyApi = false,
    Conditions = new Dynatrace.Inputs.ApiDetectionConditionsArgs
    {
        Conditions = new[]
        {
            new Dynatrace.Inputs.ApiDetectionConditionsConditionArgs
            {
                Base = "string",
                Matcher = "string",
                Pattern = "string",
            },
        },
    },
    InsertAfter = "string",
    Technology = "string",
});

example, err := dynatrace.NewApiDetection(ctx, "apiDetectionResource", &dynatrace.ApiDetectionArgs{
	ApiColor:      pulumi.String("string"),
	ApiName:       pulumi.String("string"),
	ThirdPartyApi: pulumi.Bool(false),
	Conditions: &dynatrace.ApiDetectionConditionsArgs{
		Conditions: dynatrace.ApiDetectionConditionsConditionArray{
			&dynatrace.ApiDetectionConditionsConditionArgs{
				Base:    pulumi.String("string"),
				Matcher: pulumi.String("string"),
				Pattern: pulumi.String("string"),
			},
		},
	},
	InsertAfter: pulumi.String("string"),
	Technology:  pulumi.String("string"),
})

var apiDetectionResource = new ApiDetection("apiDetectionResource", ApiDetectionArgs.builder()
    .apiColor("string")
    .apiName("string")
    .thirdPartyApi(false)
    .conditions(ApiDetectionConditionsArgs.builder()
        .conditions(ApiDetectionConditionsConditionArgs.builder()
            .base("string")
            .matcher("string")
            .pattern("string")
            .build())
        .build())
    .insertAfter("string")
    .technology("string")
    .build());

api_detection_resource = dynatrace.ApiDetection("apiDetectionResource",
    api_color="string",
    api_name="string",
    third_party_api=False,
    conditions={
        "conditions": [{
            "base": "string",
            "matcher": "string",
            "pattern": "string",
        }],
    },
    insert_after="string",
    technology="string")

const apiDetectionResource = new dynatrace.ApiDetection("apiDetectionResource", {
    apiColor: "string",
    apiName: "string",
    thirdPartyApi: false,
    conditions: {
        conditions: [{
            base: "string",
            matcher: "string",
            pattern: "string",
        }],
    },
    insertAfter: "string",
    technology: "string",
});

type: dynatrace:ApiDetection
properties:
    apiColor: string
    apiName: string
    conditions:
        conditions:
            - base: string
              matcher: string
              pattern: string
    insertAfter: string
    technology: string
    thirdPartyApi: false

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

ApiColor string: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
ApiName string: API name
ThirdPartyApi bool: This API defines a third party library
Conditions Pulumiverse.Dynatrace.Inputs.ApiDetectionConditions: List of conditions
InsertAfter string: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
Technology string: Restrict this rule to a specific technology.

ApiColor string: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
ApiName string: API name
ThirdPartyApi bool: This API defines a third party library
Conditions ApiDetectionConditionsArgs: List of conditions
InsertAfter string: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
Technology string: Restrict this rule to a specific technology.

apiColor String: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
apiName String: API name
thirdPartyApi Boolean: This API defines a third party library
conditions ApiDetectionConditions: List of conditions
insertAfter String: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
technology String: Restrict this rule to a specific technology.

apiColor string: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
apiName string: API name
thirdPartyApi boolean: This API defines a third party library
conditions ApiDetectionConditions: List of conditions
insertAfter string: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
technology string: Restrict this rule to a specific technology.

api_color str: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
api_name str: API name
third_party_api bool: This API defines a third party library
conditions ApiDetectionConditionsArgs: List of conditions
insert_after str: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
technology str: Restrict this rule to a specific technology.

apiColor String: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
apiName String: API name
thirdPartyApi Boolean: This API defines a third party library
conditions Property Map: List of conditions
insertAfter String: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
technology String: Restrict this rule to a specific technology.

Outputs

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

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

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        api_color: Optional[str] = None,
        api_name: Optional[str] = None,
        conditions: Optional[ApiDetectionConditionsArgs] = None,
        insert_after: Optional[str] = None,
        technology: Optional[str] = None,
        third_party_api: Optional[bool] = None) -> ApiDetection

func GetApiDetection(ctx *Context, name string, id IDInput, state *ApiDetectionState, opts ...ResourceOption) (*ApiDetection, error)

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

public static ApiDetection get(String name, Output<String> id, ApiDetectionState 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:

ApiColor string: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
ApiName string: API name
Conditions Pulumiverse.Dynatrace.Inputs.ApiDetectionConditions: List of conditions
InsertAfter string: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
Technology string: Restrict this rule to a specific technology.
ThirdPartyApi bool: This API defines a third party library

ApiColor string: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
ApiName string: API name
Conditions ApiDetectionConditionsArgs: List of conditions
InsertAfter string: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
Technology string: Restrict this rule to a specific technology.
ThirdPartyApi bool: This API defines a third party library

apiColor String: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
apiName String: API name
conditions ApiDetectionConditions: List of conditions
insertAfter String: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
technology String: Restrict this rule to a specific technology.
thirdPartyApi Boolean: This API defines a third party library

apiColor string: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
apiName string: API name
conditions ApiDetectionConditions: List of conditions
insertAfter string: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
technology string: Restrict this rule to a specific technology.
thirdPartyApi boolean: This API defines a third party library

api_color str: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
api_name str: API name
conditions ApiDetectionConditionsArgs: List of conditions
insert_after str: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
technology str: Restrict this rule to a specific technology.
third_party_api bool: This API defines a third party library

apiColor String: This color will be used to highlight APIs when viewing code level data, such as distributed traces or method hotspots.
apiName String: API name
conditions Property Map: List of conditions
insertAfter String: Because this resource allows for ordering you may specify the ID of the resource instance that comes before this instance regarding order. If not specified when creating the setting will be added to the end of the list. If not specified during update the order will remain untouched
technology String: Restrict this rule to a specific technology.
thirdPartyApi Boolean: This API defines a third party library