typed-aws
Version:
Helps you write AWS CloudFormation in TypeScript
110 lines (109 loc) • 4.82 kB
TypeScript
import { CfnResource, Resolvable } from '../../base';
export declare type Contact_Type = 'AWS::SSMContacts::Contact';
export declare const Contact_Type = "AWS::SSMContacts::Contact";
/**
* Resource Type definition for AWS::SSMContacts::Contact {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html}
*/
export default function Contact(props: Contact_Properties): CfnResource<Contact_Properties>;
/**
* Resource Type definition for AWS::SSMContacts::Contact {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html}
*/
export declare type Contact_Properties = {
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-alias}
*/
Alias: Resolvable<string>;
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-displayname}
*/
DisplayName: Resolvable<string>;
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-type}
*/
Type: Resolvable<'PERSONAL' | 'CUSTOM' | 'SERVICE' | 'ESCALATION'>;
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ssmcontacts-contact.html#cfn-ssmcontacts-contact-plan}
*/
Plan: Stage[];
Arn?: Resolvable<string>;
};
/**
* The contact that SSM Incident Manager is engaging during an incident.
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-contacttargetinfo.html}
*/
export declare type ContactTargetInfo = {
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-contacttargetinfo.html#cfn-ssmcontacts-contact-contacttargetinfo-contactid}
*/
ContactId: Resolvable<string>;
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-contacttargetinfo.html#cfn-ssmcontacts-contact-contacttargetinfo-isessential}
*/
IsEssential: Resolvable<boolean>;
};
/**
* Information about the contact channel that SSM Incident Manager uses
* to engage the contact. {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-channeltargetinfo.html}
*/
export declare type ChannelTargetInfo = {
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-channeltargetinfo.html#cfn-ssmcontacts-contact-channeltargetinfo-channelid}
*/
ChannelId: Resolvable<string>;
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-channeltargetinfo.html#cfn-ssmcontacts-contact-channeltargetinfo-retryintervalinminutes}
*/
RetryIntervalInMinutes: Resolvable<number>;
};
/**
* A set amount of time that an escalation plan or engagement plan
* engages the specified contacts or contact methods. {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html}
*/
export declare type Stage = {
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html#cfn-ssmcontacts-contact-stage-durationinminutes}
*/
DurationInMinutes: Resolvable<number>;
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-stage.html#cfn-ssmcontacts-contact-stage-targets}
*/
Targets?: Targets[];
};
export declare type Targets = {
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-targets.html#cfn-ssmcontacts-contact-targets-contacttargetinfo}
*/
ContactTargetInfo?: ContactTargetInfo;
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-targets.html#cfn-ssmcontacts-contact-targets-channeltargetinfo}
*/
ChannelTargetInfo: ChannelTargetInfo;
} | {
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-targets.html#cfn-ssmcontacts-contact-targets-contacttargetinfo}
*/
ContactTargetInfo: ContactTargetInfo;
/**
* {@link
* http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-ssmcontacts-contact-targets.html#cfn-ssmcontacts-contact-targets-channeltargetinfo}
*/
ChannelTargetInfo?: ChannelTargetInfo;
};