345 lines
14 KiB
TypeScript
345 lines
14 KiB
TypeScript
import * as cdk from "../../core/lib";
|
|
import * as constructs from "constructs";
|
|
import * as cfn_parse from "../../core/lib/helpers-internal";
|
|
import { GraphReference, IGraphRef, IMemberInvitationRef, IOrganizationAdminRef, MemberInvitationReference, OrganizationAdminReference } from "../../interfaces/generated/aws-detective-interfaces.generated";
|
|
/**
|
|
* The `AWS::Detective::Graph` resource is an Amazon Detective resource type that creates a Detective behavior graph.
|
|
*
|
|
* The requesting account becomes the administrator account for the behavior graph.
|
|
*
|
|
* @cloudformationResource AWS::Detective::Graph
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-graph.html
|
|
*/
|
|
export declare class CfnGraph extends cdk.CfnResource implements cdk.IInspectable, IGraphRef, cdk.ITaggable {
|
|
/**
|
|
* The CloudFormation resource type name for this resource class.
|
|
*/
|
|
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
|
/**
|
|
* Build a CfnGraph from CloudFormation properties
|
|
*
|
|
* A factory method that creates a new instance of this class from an object
|
|
* containing the CloudFormation properties of this resource.
|
|
* Used in the @aws-cdk/cloudformation-include module.
|
|
*
|
|
* @internal
|
|
*/
|
|
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnGraph;
|
|
/**
|
|
* Checks whether the given object is a CfnGraph
|
|
*/
|
|
static isCfnGraph(x: any): x is CfnGraph;
|
|
static arnForGraph(resource: IGraphRef): string;
|
|
/**
|
|
* Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
|
|
*/
|
|
private _autoEnableMembers?;
|
|
/**
|
|
* Tag Manager which manages the tags for this resource
|
|
*/
|
|
readonly tags: cdk.TagManager;
|
|
/**
|
|
* The tag values to assign to the new behavior graph.
|
|
*/
|
|
private _tagsRaw?;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::Detective::Graph`.
|
|
*
|
|
* @param scope Scope in which this resource is defined
|
|
* @param id Construct identifier for this resource (unique in its scope)
|
|
* @param props Resource properties
|
|
*/
|
|
constructor(scope: constructs.Construct, id: string, props?: CfnGraphProps);
|
|
get graphRef(): GraphReference;
|
|
/**
|
|
* Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
|
|
*/
|
|
get autoEnableMembers(): boolean | cdk.IResolvable | undefined;
|
|
/**
|
|
* Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
|
|
*/
|
|
set autoEnableMembers(value: boolean | cdk.IResolvable | undefined);
|
|
/**
|
|
* The tag values to assign to the new behavior graph.
|
|
*/
|
|
get tagsRaw(): Array<cdk.CfnTag> | undefined;
|
|
/**
|
|
* The tag values to assign to the new behavior graph.
|
|
*/
|
|
set tagsRaw(value: Array<cdk.CfnTag> | undefined);
|
|
/**
|
|
* The ARN of the new behavior graph.
|
|
*
|
|
* @cloudformationAttribute Arn
|
|
*/
|
|
get attrArn(): string;
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnGraph`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-graph.html
|
|
*/
|
|
export interface CfnGraphProps {
|
|
/**
|
|
* Indicates whether to automatically enable new organization accounts as member accounts in the organization behavior graph.
|
|
*
|
|
* By default, this property is set to `false` . If you want to change the value of this property, you must be the Detective administrator for the organization. For more information on setting a Detective administrator account, see [AWS::Detective::OrganizationAdmin](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-organizationadmin.html) .
|
|
*
|
|
* @default - false
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-graph.html#cfn-detective-graph-autoenablemembers
|
|
*/
|
|
readonly autoEnableMembers?: boolean | cdk.IResolvable;
|
|
/**
|
|
* The tag values to assign to the new behavior graph.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-graph.html#cfn-detective-graph-tags
|
|
*/
|
|
readonly tags?: Array<cdk.CfnTag>;
|
|
}
|
|
/**
|
|
* The `AWS::Detective::MemberInvitation` resource is an Amazon Detective resource type that creates an invitation to join a Detective behavior graph.
|
|
*
|
|
* The administrator account can choose whether to send an email notification of the invitation to the root user email address of the AWS account.
|
|
*
|
|
* @cloudformationResource AWS::Detective::MemberInvitation
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html
|
|
*/
|
|
export declare class CfnMemberInvitation extends cdk.CfnResource implements cdk.IInspectable, IMemberInvitationRef {
|
|
/**
|
|
* The CloudFormation resource type name for this resource class.
|
|
*/
|
|
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
|
/**
|
|
* Build a CfnMemberInvitation from CloudFormation properties
|
|
*
|
|
* A factory method that creates a new instance of this class from an object
|
|
* containing the CloudFormation properties of this resource.
|
|
* Used in the @aws-cdk/cloudformation-include module.
|
|
*
|
|
* @internal
|
|
*/
|
|
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnMemberInvitation;
|
|
/**
|
|
* Checks whether the given object is a CfnMemberInvitation
|
|
*/
|
|
static isCfnMemberInvitation(x: any): x is CfnMemberInvitation;
|
|
/**
|
|
* Whether to send an invitation email to the member account.
|
|
*/
|
|
private _disableEmailNotification?;
|
|
/**
|
|
* The ARN of the behavior graph to invite the account to contribute data to.
|
|
*/
|
|
private _graphArn;
|
|
/**
|
|
* The root user email address of the invited account.
|
|
*/
|
|
private _memberEmailAddress;
|
|
/**
|
|
* The AWS account identifier of the invited account.
|
|
*/
|
|
private _memberId;
|
|
/**
|
|
* Customized text to include in the invitation email message.
|
|
*/
|
|
private _message?;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::Detective::MemberInvitation`.
|
|
*
|
|
* @param scope Scope in which this resource is defined
|
|
* @param id Construct identifier for this resource (unique in its scope)
|
|
* @param props Resource properties
|
|
*/
|
|
constructor(scope: constructs.Construct, id: string, props: CfnMemberInvitationProps);
|
|
get memberInvitationRef(): MemberInvitationReference;
|
|
/**
|
|
* Whether to send an invitation email to the member account.
|
|
*/
|
|
get disableEmailNotification(): boolean | cdk.IResolvable | undefined;
|
|
/**
|
|
* Whether to send an invitation email to the member account.
|
|
*/
|
|
set disableEmailNotification(value: boolean | cdk.IResolvable | undefined);
|
|
/**
|
|
* The ARN of the behavior graph to invite the account to contribute data to.
|
|
*/
|
|
get graphArn(): string;
|
|
/**
|
|
* The ARN of the behavior graph to invite the account to contribute data to.
|
|
*/
|
|
set graphArn(value: string);
|
|
/**
|
|
* The root user email address of the invited account.
|
|
*/
|
|
get memberEmailAddress(): string;
|
|
/**
|
|
* The root user email address of the invited account.
|
|
*/
|
|
set memberEmailAddress(value: string);
|
|
/**
|
|
* The AWS account identifier of the invited account.
|
|
*/
|
|
get memberId(): string;
|
|
/**
|
|
* The AWS account identifier of the invited account.
|
|
*/
|
|
set memberId(value: string);
|
|
/**
|
|
* Customized text to include in the invitation email message.
|
|
*/
|
|
get message(): string | undefined;
|
|
/**
|
|
* Customized text to include in the invitation email message.
|
|
*/
|
|
set message(value: string | undefined);
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnMemberInvitation`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html
|
|
*/
|
|
export interface CfnMemberInvitationProps {
|
|
/**
|
|
* Whether to send an invitation email to the member account.
|
|
*
|
|
* If set to true, the member account does not receive an invitation email.
|
|
*
|
|
* @default - false
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-disableemailnotification
|
|
*/
|
|
readonly disableEmailNotification?: boolean | cdk.IResolvable;
|
|
/**
|
|
* The ARN of the behavior graph to invite the account to contribute data to.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-grapharn
|
|
*/
|
|
readonly graphArn: string;
|
|
/**
|
|
* The root user email address of the invited account.
|
|
*
|
|
* If the email address provided is not the root user email address for the provided account, the invitation creation fails.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-memberemailaddress
|
|
*/
|
|
readonly memberEmailAddress: string;
|
|
/**
|
|
* The AWS account identifier of the invited account.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-memberid
|
|
*/
|
|
readonly memberId: string;
|
|
/**
|
|
* Customized text to include in the invitation email message.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-memberinvitation.html#cfn-detective-memberinvitation-message
|
|
*/
|
|
readonly message?: string;
|
|
}
|
|
/**
|
|
* The `AWS::Detective::OrganizationAdmin` resource is an Amazon Detective resource type that designates the Detective administrator account for the organization in the current region.
|
|
*
|
|
* If the account does not have Detective enabled, then this resource enables Detective for that account and creates a new behavior graph.
|
|
*
|
|
* @cloudformationResource AWS::Detective::OrganizationAdmin
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-organizationadmin.html
|
|
*/
|
|
export declare class CfnOrganizationAdmin extends cdk.CfnResource implements cdk.IInspectable, IOrganizationAdminRef {
|
|
/**
|
|
* The CloudFormation resource type name for this resource class.
|
|
*/
|
|
static readonly CFN_RESOURCE_TYPE_NAME: string;
|
|
/**
|
|
* Build a CfnOrganizationAdmin from CloudFormation properties
|
|
*
|
|
* A factory method that creates a new instance of this class from an object
|
|
* containing the CloudFormation properties of this resource.
|
|
* Used in the @aws-cdk/cloudformation-include module.
|
|
*
|
|
* @internal
|
|
*/
|
|
static _fromCloudFormation(scope: constructs.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnOrganizationAdmin;
|
|
/**
|
|
* Checks whether the given object is a CfnOrganizationAdmin
|
|
*/
|
|
static isCfnOrganizationAdmin(x: any): x is CfnOrganizationAdmin;
|
|
/**
|
|
* The AWS account identifier of the account to designate as the Detective administrator account for the organization.
|
|
*/
|
|
private _accountId;
|
|
protected readonly cfnPropertyNames: Record<string, string>;
|
|
/**
|
|
* Create a new `AWS::Detective::OrganizationAdmin`.
|
|
*
|
|
* @param scope Scope in which this resource is defined
|
|
* @param id Construct identifier for this resource (unique in its scope)
|
|
* @param props Resource properties
|
|
*/
|
|
constructor(scope: constructs.Construct, id: string, props: CfnOrganizationAdminProps);
|
|
get organizationAdminRef(): OrganizationAdminReference;
|
|
/**
|
|
* The AWS account identifier of the account to designate as the Detective administrator account for the organization.
|
|
*/
|
|
get accountId(): string;
|
|
/**
|
|
* The AWS account identifier of the account to designate as the Detective administrator account for the organization.
|
|
*/
|
|
set accountId(value: string);
|
|
/**
|
|
* The ARN of the behavior graph to invite the account to contribute data to.
|
|
*
|
|
* @cloudformationAttribute GraphArn
|
|
*/
|
|
get attrGraphArn(): string;
|
|
protected get cfnProperties(): Record<string, any>;
|
|
/**
|
|
* Examines the CloudFormation resource and discloses attributes
|
|
*
|
|
* @param inspector tree inspector to collect and process attributes
|
|
*/
|
|
inspect(inspector: cdk.TreeInspector): void;
|
|
protected renderProperties(props: Record<string, any>): Record<string, any>;
|
|
}
|
|
/**
|
|
* Properties for defining a `CfnOrganizationAdmin`
|
|
*
|
|
* @struct
|
|
* @stability external
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-organizationadmin.html
|
|
*/
|
|
export interface CfnOrganizationAdminProps {
|
|
/**
|
|
* The AWS account identifier of the account to designate as the Detective administrator account for the organization.
|
|
*
|
|
* @see http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-detective-organizationadmin.html#cfn-detective-organizationadmin-accountid
|
|
*/
|
|
readonly accountId: string;
|
|
}
|
|
export type { IGraphRef, GraphReference };
|
|
export type { IMemberInvitationRef, MemberInvitationReference };
|
|
export type { IOrganizationAdminRef, OrganizationAdminReference };
|