@pulumi/aws-native
Version:
The Pulumi AWS Cloud Control Provider enables you to build, deploy, and manage [any AWS resource that's supported by the AWS Cloud Control API](https://github.com/pulumi/pulumi-aws-native/blob/master/provider/cmd/pulumi-gen-aws-native/supported-types.txt)
59 lines (58 loc) • 2.21 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* A security profile defines a set of expected behaviors for devices in your account.
*/
export declare function getSecurityProfile(args: GetSecurityProfileArgs, opts?: pulumi.InvokeOptions): Promise<GetSecurityProfileResult>;
export interface GetSecurityProfileArgs {
/**
* A unique identifier for the security profile.
*/
securityProfileName: string;
}
export interface GetSecurityProfileResult {
/**
* A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here.
*/
readonly additionalMetricsToRetainV2?: outputs.iot.SecurityProfileMetricToRetain[];
/**
* Specifies the destinations to which alerts are sent.
*/
readonly alertTargets?: {
[key: string]: outputs.iot.SecurityProfileAlertTarget;
};
/**
* Specifies the behaviors that, when violated by a device (thing), cause an alert.
*/
readonly behaviors?: outputs.iot.SecurityProfileBehavior[];
/**
* A structure containing the mqtt topic for metrics export.
*/
readonly metricsExportConfig?: outputs.iot.MetricsExportConfigProperties;
/**
* The ARN (Amazon resource name) of the created security profile.
*/
readonly securityProfileArn?: string;
/**
* A description of the security profile.
*/
readonly securityProfileDescription?: string;
/**
* Metadata that can be used to manage the security profile.
*/
readonly tags?: outputs.Tag[];
/**
* A set of target ARNs that the security profile is attached to.
*/
readonly targetArns?: string[];
}
/**
* A security profile defines a set of expected behaviors for devices in your account.
*/
export declare function getSecurityProfileOutput(args: GetSecurityProfileOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetSecurityProfileResult>;
export interface GetSecurityProfileOutputArgs {
/**
* A unique identifier for the security profile.
*/
securityProfileName: pulumi.Input<string>;
}