@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
203 lines (202 loc) • 7.97 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Provides a CodeBuild Report Groups Resource.
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const current = aws.getCallerIdentity({});
* const example = current.then(current => aws.iam.getPolicyDocument({
* statements: [{
* sid: "Enable IAM User Permissions",
* effect: "Allow",
* principals: [{
* type: "AWS",
* identifiers: [`arn:aws:iam::${current.accountId}:root`],
* }],
* actions: ["kms:*"],
* resources: ["*"],
* }],
* }));
* const exampleKey = new aws.kms.Key("example", {
* description: "my test kms key",
* deletionWindowInDays: 7,
* policy: example.then(example => example.json),
* });
* const exampleBucket = new aws.s3.Bucket("example", {bucket: "my-test"});
* const exampleReportGroup = new aws.codebuild.ReportGroup("example", {
* name: "my test report group",
* type: "TEST",
* exportConfig: {
* type: "S3",
* s3Destination: {
* bucket: exampleBucket.id,
* encryptionDisabled: false,
* encryptionKey: exampleKey.arn,
* packaging: "NONE",
* path: "/some",
* },
* },
* });
* ```
*
* ## Import
*
* ### Identity Schema
*
* #### Required
*
* - `arn` (String) Amazon Resource Name (ARN) of the CodeBuild report group.
*
* Using `pulumi import`, import CodeBuild Report Group using the CodeBuild Report Group arn. For example:
*
* console
*
* % pulumi import aws_codebuild_report_group.example arn:aws:codebuild:us-west-2:123456789:report-group/report-group-name
*/
export declare class ReportGroup extends pulumi.CustomResource {
/**
* Get an existing ReportGroup 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?: ReportGroupState, opts?: pulumi.CustomResourceOptions): ReportGroup;
/**
* Returns true if the given object is an instance of ReportGroup. 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 ReportGroup;
/**
* The ARN of Report Group.
*/
readonly arn: pulumi.Output<string>;
/**
* The date and time this Report Group was created.
*/
readonly created: pulumi.Output<string>;
/**
* If `true`, deletes any reports that belong to a report group before deleting the report group. If `false`, you must delete any reports in the report group before deleting it. Default value is `false`.
*/
readonly deleteReports: pulumi.Output<boolean | undefined>;
/**
* Information about the destination where the raw data of this Report Group is exported. see Export Config documented below.
*/
readonly exportConfig: pulumi.Output<outputs.codebuild.ReportGroupExportConfig>;
/**
* The name of a Report Group.
*/
readonly name: pulumi.Output<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
readonly region: pulumi.Output<string>;
/**
* Key-value mapping of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
/**
* The type of the Report Group. Valid value are `TEST` and `CODE_COVERAGE`.
*/
readonly type: pulumi.Output<string>;
/**
* Create a ReportGroup 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: ReportGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ReportGroup resources.
*/
export interface ReportGroupState {
/**
* The ARN of Report Group.
*/
arn?: pulumi.Input<string>;
/**
* The date and time this Report Group was created.
*/
created?: pulumi.Input<string>;
/**
* If `true`, deletes any reports that belong to a report group before deleting the report group. If `false`, you must delete any reports in the report group before deleting it. Default value is `false`.
*/
deleteReports?: pulumi.Input<boolean>;
/**
* Information about the destination where the raw data of this Report Group is exported. see Export Config documented below.
*/
exportConfig?: pulumi.Input<inputs.codebuild.ReportGroupExportConfig>;
/**
* The name of a Report Group.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Key-value mapping of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The type of the Report Group. Valid value are `TEST` and `CODE_COVERAGE`.
*/
type?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a ReportGroup resource.
*/
export interface ReportGroupArgs {
/**
* If `true`, deletes any reports that belong to a report group before deleting the report group. If `false`, you must delete any reports in the report group before deleting it. Default value is `false`.
*/
deleteReports?: pulumi.Input<boolean>;
/**
* Information about the destination where the raw data of this Report Group is exported. see Export Config documented below.
*/
exportConfig: pulumi.Input<inputs.codebuild.ReportGroupExportConfig>;
/**
* The name of a Report Group.
*/
name?: pulumi.Input<string>;
/**
* Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
*/
region?: pulumi.Input<string>;
/**
* Key-value mapping of resource tags. .If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The type of the Report Group. Valid value are `TEST` and `CODE_COVERAGE`.
*/
type: pulumi.Input<string>;
}