@pulumi/cloudngfwaws
Version:
A Pulumi package for creating and managing Cloud NGFW for AWS resources.
234 lines (233 loc) • 7.83 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Resource for Account Onboarding.
*
* ## Admin Permission Type
*
* * `Rulestack` (for `scope="Local"`)
* * `Global Rulestack` (for `scope="Global"`)
*/
export declare class AccountOnboardingStack extends pulumi.CustomResource {
/**
* Get an existing AccountOnboardingStack resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AccountOnboardingStackState, opts?: pulumi.CustomResourceOptions): AccountOnboardingStack;
/**
* Returns true if the given object is an instance of AccountOnboardingStack. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AccountOnboardingStack;
/**
* The account IDs
*/
readonly accountId: pulumi.Output<string>;
/**
* Audit Log Group Name
*/
readonly auditlogGroup: pulumi.Output<string | undefined>;
/**
* Role name to run the account onboarding CFT in each account to be onboarded.
*/
readonly cftRoleName: pulumi.Output<string>;
/**
* Cloudwatch Log Group
*/
readonly cloudwatchLogGroup: pulumi.Output<string | undefined>;
/**
* Cloudwatch Namespace
*/
readonly cloudwatchNamespace: pulumi.Output<string | undefined>;
/**
* The CloudNGFW can decrypt inbound and outbound traffic by providing a
* certificate stored in secret Manager.
* The role allows the service to access a certificate configured in the rulestack.
* Only certificated tagged with PaloAltoCloudNGFW can be accessed
*/
readonly decryptionCert: pulumi.Output<string | undefined>;
/**
* Controls whether cloud NGFW will create firewall endpoints automatitically in customer subnets
*/
readonly endpointMode: pulumi.Output<string | undefined>;
/**
* External Id of the onboarded account
*/
readonly externalId: pulumi.Output<string>;
/**
* Kinesis Firehose for logging
*/
readonly kinesisFirehose: pulumi.Output<string | undefined>;
/**
* Role name to run the account onboarding CFT in each account to be onboarded.
*/
readonly onboardingCft: pulumi.Output<string>;
/**
* S3 Bucket Name for Logging. Logging roles provide access to create log contents in this bucket.
*/
readonly s3Bucket: pulumi.Output<string | undefined>;
/**
* SNS topic ARN to publish the role ARNs
*/
readonly snsTopicArn: pulumi.Output<string>;
/**
* ID of the account onboarding CFT stack
*/
readonly stackId: pulumi.Output<string>;
/**
* Status of the account onboarding CFT stack.
*/
readonly stackStatus: pulumi.Output<string>;
/**
* PANW Cloud NGFW trusted account Id
*/
readonly trustedAccount: pulumi.Output<string>;
/**
* Create a AccountOnboardingStack resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AccountOnboardingStackArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AccountOnboardingStack resources.
*/
export interface AccountOnboardingStackState {
/**
* The account IDs
*/
accountId?: pulumi.Input<string>;
/**
* Audit Log Group Name
*/
auditlogGroup?: pulumi.Input<string>;
/**
* Role name to run the account onboarding CFT in each account to be onboarded.
*/
cftRoleName?: pulumi.Input<string>;
/**
* Cloudwatch Log Group
*/
cloudwatchLogGroup?: pulumi.Input<string>;
/**
* Cloudwatch Namespace
*/
cloudwatchNamespace?: pulumi.Input<string>;
/**
* The CloudNGFW can decrypt inbound and outbound traffic by providing a
* certificate stored in secret Manager.
* The role allows the service to access a certificate configured in the rulestack.
* Only certificated tagged with PaloAltoCloudNGFW can be accessed
*/
decryptionCert?: pulumi.Input<string>;
/**
* Controls whether cloud NGFW will create firewall endpoints automatitically in customer subnets
*/
endpointMode?: pulumi.Input<string>;
/**
* External Id of the onboarded account
*/
externalId?: pulumi.Input<string>;
/**
* Kinesis Firehose for logging
*/
kinesisFirehose?: pulumi.Input<string>;
/**
* Role name to run the account onboarding CFT in each account to be onboarded.
*/
onboardingCft?: pulumi.Input<string>;
/**
* S3 Bucket Name for Logging. Logging roles provide access to create log contents in this bucket.
*/
s3Bucket?: pulumi.Input<string>;
/**
* SNS topic ARN to publish the role ARNs
*/
snsTopicArn?: pulumi.Input<string>;
/**
* ID of the account onboarding CFT stack
*/
stackId?: pulumi.Input<string>;
/**
* Status of the account onboarding CFT stack.
*/
stackStatus?: pulumi.Input<string>;
/**
* PANW Cloud NGFW trusted account Id
*/
trustedAccount?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a AccountOnboardingStack resource.
*/
export interface AccountOnboardingStackArgs {
/**
* The account IDs
*/
accountId: pulumi.Input<string>;
/**
* Audit Log Group Name
*/
auditlogGroup?: pulumi.Input<string>;
/**
* Role name to run the account onboarding CFT in each account to be onboarded.
*/
cftRoleName: pulumi.Input<string>;
/**
* Cloudwatch Log Group
*/
cloudwatchLogGroup?: pulumi.Input<string>;
/**
* Cloudwatch Namespace
*/
cloudwatchNamespace?: pulumi.Input<string>;
/**
* The CloudNGFW can decrypt inbound and outbound traffic by providing a
* certificate stored in secret Manager.
* The role allows the service to access a certificate configured in the rulestack.
* Only certificated tagged with PaloAltoCloudNGFW can be accessed
*/
decryptionCert?: pulumi.Input<string>;
/**
* Controls whether cloud NGFW will create firewall endpoints automatitically in customer subnets
*/
endpointMode?: pulumi.Input<string>;
/**
* External Id of the onboarded account
*/
externalId: pulumi.Input<string>;
/**
* Kinesis Firehose for logging
*/
kinesisFirehose?: pulumi.Input<string>;
/**
* Role name to run the account onboarding CFT in each account to be onboarded.
*/
onboardingCft: pulumi.Input<string>;
/**
* S3 Bucket Name for Logging. Logging roles provide access to create log contents in this bucket.
*/
s3Bucket?: pulumi.Input<string>;
/**
* SNS topic ARN to publish the role ARNs
*/
snsTopicArn: pulumi.Input<string>;
/**
* ID of the account onboarding CFT stack
*/
stackId?: pulumi.Input<string>;
/**
* Status of the account onboarding CFT stack.
*/
stackStatus?: pulumi.Input<string>;
/**
* PANW Cloud NGFW trusted account Id
*/
trustedAccount: pulumi.Input<string>;
}