@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)
75 lines (74 loc) • 3.94 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as enums from "../types/enums";
/**
* The AWS::SecurityHub::OrganizationConfiguration resource represents the configuration of your organization in Security Hub. Only the Security Hub administrator account can create Organization Configuration resource in each region and can opt-in to Central Configuration only in the aggregation region of FindingAggregator.
*/
export declare class OrganizationConfiguration extends pulumi.CustomResource {
/**
* Get an existing OrganizationConfiguration 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 opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): OrganizationConfiguration;
/**
* Returns true if the given object is an instance of OrganizationConfiguration. 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 OrganizationConfiguration;
/**
* Whether to automatically enable Security Hub in new member accounts when they join the organization.
*/
readonly autoEnable: pulumi.Output<boolean>;
/**
* Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
*/
readonly autoEnableStandards: pulumi.Output<enums.securityhub.OrganizationConfigurationAutoEnableStandards | undefined>;
/**
* Indicates whether the organization uses local or central configuration.
*/
readonly configurationType: pulumi.Output<enums.securityhub.OrganizationConfigurationConfigurationType | undefined>;
/**
* Whether the maximum number of allowed member accounts are already associated with the Security Hub administrator account.
*/
readonly memberAccountLimitReached: pulumi.Output<boolean>;
/**
* The identifier of the OrganizationConfiguration being created and assigned as the unique identifier.
*/
readonly organizationConfigurationIdentifier: pulumi.Output<string>;
/**
* Describes whether central configuration could be enabled as the ConfigurationType for the organization.
*/
readonly status: pulumi.Output<enums.securityhub.OrganizationConfigurationStatus>;
/**
* Provides an explanation if the value of Status is equal to FAILED when ConfigurationType is equal to CENTRAL.
*/
readonly statusMessage: pulumi.Output<string>;
/**
* Create a OrganizationConfiguration 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: OrganizationConfigurationArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a OrganizationConfiguration resource.
*/
export interface OrganizationConfigurationArgs {
/**
* Whether to automatically enable Security Hub in new member accounts when they join the organization.
*/
autoEnable: pulumi.Input<boolean>;
/**
* Whether to automatically enable Security Hub default standards in new member accounts when they join the organization.
*/
autoEnableStandards?: pulumi.Input<enums.securityhub.OrganizationConfigurationAutoEnableStandards>;
/**
* Indicates whether the organization uses local or central configuration.
*/
configurationType?: pulumi.Input<enums.securityhub.OrganizationConfigurationConfigurationType>;
}