@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
197 lines (196 loc) • 7.38 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* Creates an Amazon CloudFront Connection Group.
*
* For information about CloudFront Connection Groups, see the [AWS CloudFormation Documentation](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-cloudfront-connectiongroup.html).
*
* ## Example Usage
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const example = new aws.cloudfront.ConnectionGroup("example", {
* name: "example",
* enabled: true,
* ipv6Enabled: true,
* });
* ```
*
* ## Import
*
* Using `pulumi import`, import CloudFront Connection Groups using the `id`. For example:
*
* ```sh
* $ pulumi import aws:cloudfront/connectionGroup:ConnectionGroup example CGROUP123EXAMPLE
* ```
*/
export declare class ConnectionGroup extends pulumi.CustomResource {
/**
* Get an existing ConnectionGroup 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?: ConnectionGroupState, opts?: pulumi.CustomResourceOptions): ConnectionGroup;
/**
* Returns true if the given object is an instance of ConnectionGroup. 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 ConnectionGroup;
/**
* ID of the associated Anycast IP List. `ipv6Enabled` must not be set to `true` in order to set this argument
*/
readonly anycastIpListId: pulumi.Output<string | undefined>;
/**
* ARN of the connection group.
*/
readonly arn: pulumi.Output<string>;
/**
* Whether the connection group is enabled. Default is `true`.
*/
readonly enabled: pulumi.Output<boolean>;
/**
* Current version of the connection group.
*/
readonly etag: pulumi.Output<string>;
/**
* Whether IPv6 is enabled for the connection group. Default is `false`.
*/
readonly ipv6Enabled: pulumi.Output<boolean>;
/**
* Whether the connection group is the default connection group for the distribution tenants.
*/
readonly isDefault: pulumi.Output<boolean>;
/**
* Date and time when the connection group was last modified.
*/
readonly lastModifiedTime: pulumi.Output<string>;
/**
* Name of the connection group.
*/
readonly name: pulumi.Output<string>;
/**
* The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
*/
readonly routingEndpoint: pulumi.Output<string>;
/**
* Current status of the connection group.
*/
readonly status: pulumi.Output<string>;
/**
* A map of tags to assign to the resource. 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>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
readonly tagsAll: pulumi.Output<{
[key: string]: string;
}>;
readonly timeouts: pulumi.Output<outputs.cloudfront.ConnectionGroupTimeouts | undefined>;
readonly waitForDeployment: pulumi.Output<boolean>;
/**
* Create a ConnectionGroup 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?: ConnectionGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering ConnectionGroup resources.
*/
export interface ConnectionGroupState {
/**
* ID of the associated Anycast IP List. `ipv6Enabled` must not be set to `true` in order to set this argument
*/
anycastIpListId?: pulumi.Input<string>;
/**
* ARN of the connection group.
*/
arn?: pulumi.Input<string>;
/**
* Whether the connection group is enabled. Default is `true`.
*/
enabled?: pulumi.Input<boolean>;
/**
* Current version of the connection group.
*/
etag?: pulumi.Input<string>;
/**
* Whether IPv6 is enabled for the connection group. Default is `false`.
*/
ipv6Enabled?: pulumi.Input<boolean>;
/**
* Whether the connection group is the default connection group for the distribution tenants.
*/
isDefault?: pulumi.Input<boolean>;
/**
* Date and time when the connection group was last modified.
*/
lastModifiedTime?: pulumi.Input<string>;
/**
* Name of the connection group.
*/
name?: pulumi.Input<string>;
/**
* The routing endpoint (also known as the DNS name) that is assigned to the connection group, such as d111111abcdef8.cloudfront.net.
*/
routingEndpoint?: pulumi.Input<string>;
/**
* Current status of the connection group.
*/
status?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. 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>;
}>;
/**
* Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
*/
tagsAll?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
timeouts?: pulumi.Input<inputs.cloudfront.ConnectionGroupTimeouts>;
waitForDeployment?: pulumi.Input<boolean>;
}
/**
* The set of arguments for constructing a ConnectionGroup resource.
*/
export interface ConnectionGroupArgs {
/**
* ID of the associated Anycast IP List. `ipv6Enabled` must not be set to `true` in order to set this argument
*/
anycastIpListId?: pulumi.Input<string>;
/**
* Whether the connection group is enabled. Default is `true`.
*/
enabled?: pulumi.Input<boolean>;
/**
* Whether IPv6 is enabled for the connection group. Default is `false`.
*/
ipv6Enabled?: pulumi.Input<boolean>;
/**
* Name of the connection group.
*/
name?: pulumi.Input<string>;
/**
* A map of tags to assign to the resource. 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>;
}>;
timeouts?: pulumi.Input<inputs.cloudfront.ConnectionGroupTimeouts>;
waitForDeployment?: pulumi.Input<boolean>;
}