cloudcontrol

package
v6.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 3, 2023 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type LookupResourceArgs 

type LookupResourceArgs struct {
	// Identifier of the CloudFormation resource type. For example, `vpc-12345678`.
	Identifier string `pulumi:"identifier"`
	// ARN of the IAM Role to assume for operations.
	RoleArn *string `pulumi:"roleArn"`
	// CloudFormation resource type name. For example, `AWS::EC2::VPC`.
	//
	// The following arguments are optional:
	TypeName string `pulumi:"typeName"`
	// Identifier of the CloudFormation resource type version.
	TypeVersionId *string `pulumi:"typeVersionId"`
}

A collection of arguments for invoking getResource.

type LookupResourceOutputArgs 

type LookupResourceOutputArgs struct {
	// Identifier of the CloudFormation resource type. For example, `vpc-12345678`.
	Identifier pulumi.StringInput `pulumi:"identifier"`
	// ARN of the IAM Role to assume for operations.
	RoleArn pulumi.StringPtrInput `pulumi:"roleArn"`
	// CloudFormation resource type name. For example, `AWS::EC2::VPC`.
	//
	// The following arguments are optional:
	TypeName pulumi.StringInput `pulumi:"typeName"`
	// Identifier of the CloudFormation resource type version.
	TypeVersionId pulumi.StringPtrInput `pulumi:"typeVersionId"`
}

A collection of arguments for invoking getResource.

func (LookupResourceOutputArgs) ElementType 

func (LookupResourceOutputArgs) ElementType() reflect.Type

type LookupResourceResult 

type LookupResourceResult struct {
	// The provider-assigned unique ID for this managed resource.
	Id         string `pulumi:"id"`
	Identifier string `pulumi:"identifier"`
	// JSON string matching the CloudFormation resource type schema with current configuration.
	Properties    string  `pulumi:"properties"`
	RoleArn       *string `pulumi:"roleArn"`
	TypeName      string  `pulumi:"typeName"`
	TypeVersionId *string `pulumi:"typeVersionId"`
}

A collection of values returned by getResource.

func LookupResource 

func LookupResource(ctx *pulumi.Context, args *LookupResourceArgs, opts ...pulumi.InvokeOption) (*LookupResourceResult, error)

Provides details for a Cloud Control API Resource. The reading of these resources is proxied through Cloud Control API handlers to the backend service.

## Example Usage

```go package main

import ( 

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudcontrol"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := cloudcontrol.LookupResource(ctx, &cloudcontrol.LookupResourceArgs{
			Identifier: "example",
			TypeName:   "AWS::ECS::Cluster",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

```

type LookupResourceResultOutput 

type LookupResourceResultOutput struct{ *pulumi.OutputState }

A collection of values returned by getResource.

func LookupResourceOutput 

func LookupResourceOutput(ctx *pulumi.Context, args LookupResourceOutputArgs, opts ...pulumi.InvokeOption) LookupResourceResultOutput

func (LookupResourceResultOutput) ElementType 

func (LookupResourceResultOutput) ElementType() reflect.Type

func (LookupResourceResultOutput) Id 

func (o LookupResourceResultOutput) Id() pulumi.StringOutput

The provider-assigned unique ID for this managed resource.

func (LookupResourceResultOutput) Identifier 

func (o LookupResourceResultOutput) Identifier() pulumi.StringOutput

func (LookupResourceResultOutput) Properties 

func (o LookupResourceResultOutput) Properties() pulumi.StringOutput

JSON string matching the CloudFormation resource type schema with current configuration.

func (LookupResourceResultOutput) RoleArn 

func (o LookupResourceResultOutput) RoleArn() pulumi.StringPtrOutput

func (LookupResourceResultOutput) ToLookupResourceResultOutput 

func (o LookupResourceResultOutput) ToLookupResourceResultOutput() LookupResourceResultOutput

func (LookupResourceResultOutput) ToLookupResourceResultOutputWithContext 

func (o LookupResourceResultOutput) ToLookupResourceResultOutputWithContext(ctx context.Context) LookupResourceResultOutput

func (LookupResourceResultOutput) ToOutput added in v6.1.0 

func (o LookupResourceResultOutput) ToOutput(ctx context.Context) pulumix.Output[LookupResourceResult]

func (LookupResourceResultOutput) TypeName 

func (o LookupResourceResultOutput) TypeName() pulumi.StringOutput

func (LookupResourceResultOutput) TypeVersionId 

func (o LookupResourceResultOutput) TypeVersionId() pulumi.StringPtrOutput

type Resource 

type Resource struct {
	pulumi.CustomResourceState

	// JSON string matching the CloudFormation resource type schema with desired configuration.
	DesiredState pulumi.StringOutput `pulumi:"desiredState"`
	// JSON string matching the CloudFormation resource type schema with current configuration. Underlying attributes can be referenced via the `jsondecode()` function, for example, `jsondecode(data.aws_cloudcontrolapi_resource.example.properties)["example"]`.
	Properties pulumi.StringOutput `pulumi:"properties"`
	// Amazon Resource Name (ARN) of the IAM Role to assume for operations.
	RoleArn pulumi.StringPtrOutput `pulumi:"roleArn"`
	// JSON string of the CloudFormation resource type schema which is used for plan time validation where possible. Automatically fetched if not provided. In large scale environments with multiple resources using the same `typeName`, it is recommended to fetch the schema once via the `cloudformation.CloudFormationType` data source and use this argument to reduce `DescribeType` API operation throttling. This value is marked sensitive only to prevent large plan differences from showing.
	Schema pulumi.StringOutput `pulumi:"schema"`
	// CloudFormation resource type name. For example, `AWS::EC2::VPC`.
	//
	// The following arguments are optional:
	TypeName pulumi.StringOutput `pulumi:"typeName"`
	// Identifier of the CloudFormation resource type version.
	TypeVersionId pulumi.StringPtrOutput `pulumi:"typeVersionId"`
}

Manages a Cloud Control API Resource. The configuration and lifecycle handling of these resources is proxied through Cloud Control API handlers to the backend service.

## Example Usage

```go package main

import ( 

"encoding/json"

"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/cloudcontrol"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

) 

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tmpJSON0, err := json.Marshal(map[string]interface{}{
			"ClusterName": "example",
			"Tags": []map[string]interface{}{
				map[string]interface{}{
					"Key":   "CostCenter",
					"Value": "IT",
				},
			},
		})
		if err != nil {
			return err
		}
		json0 := string(tmpJSON0)
		_, err = cloudcontrol.NewResource(ctx, "example", &cloudcontrol.ResourceArgs{
			TypeName:     pulumi.String("AWS::ECS::Cluster"),
			DesiredState: pulumi.String(json0),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

func GetResource 

func GetResource(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourceState, opts ...pulumi.ResourceOption) (*Resource, error)

GetResource gets an existing Resource resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewResource 

func NewResource(ctx *pulumi.Context,
	name string, args *ResourceArgs, opts ...pulumi.ResourceOption) (*Resource, error)

NewResource registers a new resource with the given unique name, arguments, and options.

func (*Resource) ElementType 

func (*Resource) ElementType() reflect.Type

func (*Resource) ToOutput added in v6.1.0 

func (i *Resource) ToOutput(ctx context.Context) pulumix.Output[*Resource]

func (*Resource) ToResourceOutput 

func (i *Resource) ToResourceOutput() ResourceOutput

func (*Resource) ToResourceOutputWithContext 

func (i *Resource) ToResourceOutputWithContext(ctx context.Context) ResourceOutput

type ResourceArgs 

type ResourceArgs struct {
	// JSON string matching the CloudFormation resource type schema with desired configuration.
	DesiredState pulumi.StringInput
	// Amazon Resource Name (ARN) of the IAM Role to assume for operations.
	RoleArn pulumi.StringPtrInput
	// JSON string of the CloudFormation resource type schema which is used for plan time validation where possible. Automatically fetched if not provided. In large scale environments with multiple resources using the same `typeName`, it is recommended to fetch the schema once via the `cloudformation.CloudFormationType` data source and use this argument to reduce `DescribeType` API operation throttling. This value is marked sensitive only to prevent large plan differences from showing.
	Schema pulumi.StringPtrInput
	// CloudFormation resource type name. For example, `AWS::EC2::VPC`.
	//
	// The following arguments are optional:
	TypeName pulumi.StringInput
	// Identifier of the CloudFormation resource type version.
	TypeVersionId pulumi.StringPtrInput
}

The set of arguments for constructing a Resource resource.

func (ResourceArgs) ElementType 

func (ResourceArgs) ElementType() reflect.Type

type ResourceArray 

type ResourceArray []ResourceInput

func (ResourceArray) ElementType 

func (ResourceArray) ElementType() reflect.Type

func (ResourceArray) ToOutput added in v6.1.0 

func (i ResourceArray) ToOutput(ctx context.Context) pulumix.Output[[]*Resource]

func (ResourceArray) ToResourceArrayOutput 

func (i ResourceArray) ToResourceArrayOutput() ResourceArrayOutput

func (ResourceArray) ToResourceArrayOutputWithContext 

func (i ResourceArray) ToResourceArrayOutputWithContext(ctx context.Context) ResourceArrayOutput

type ResourceArrayInput 

type ResourceArrayInput interface {
	pulumi.Input

	ToResourceArrayOutput() ResourceArrayOutput
	ToResourceArrayOutputWithContext(context.Context) ResourceArrayOutput
}

ResourceArrayInput is an input type that accepts ResourceArray and ResourceArrayOutput values. You can construct a concrete instance of `ResourceArrayInput` via: 

ResourceArray{ ResourceArgs{...} }

type ResourceArrayOutput 

type ResourceArrayOutput struct{ *pulumi.OutputState }

func (ResourceArrayOutput) ElementType 

func (ResourceArrayOutput) ElementType() reflect.Type

func (ResourceArrayOutput) Index 

func (o ResourceArrayOutput) Index(i pulumi.IntInput) ResourceOutput

func (ResourceArrayOutput) ToOutput added in v6.1.0 

func (o ResourceArrayOutput) ToOutput(ctx context.Context) pulumix.Output[[]*Resource]

func (ResourceArrayOutput) ToResourceArrayOutput 

func (o ResourceArrayOutput) ToResourceArrayOutput() ResourceArrayOutput

func (ResourceArrayOutput) ToResourceArrayOutputWithContext 

func (o ResourceArrayOutput) ToResourceArrayOutputWithContext(ctx context.Context) ResourceArrayOutput

type ResourceInput 

type ResourceInput interface {
	pulumi.Input

	ToResourceOutput() ResourceOutput
	ToResourceOutputWithContext(ctx context.Context) ResourceOutput
}

type ResourceMap 

type ResourceMap map[string]ResourceInput

func (ResourceMap) ElementType 

func (ResourceMap) ElementType() reflect.Type

func (ResourceMap) ToOutput added in v6.1.0 

func (i ResourceMap) ToOutput(ctx context.Context) pulumix.Output[map[string]*Resource]

func (ResourceMap) ToResourceMapOutput 

func (i ResourceMap) ToResourceMapOutput() ResourceMapOutput

func (ResourceMap) ToResourceMapOutputWithContext 

func (i ResourceMap) ToResourceMapOutputWithContext(ctx context.Context) ResourceMapOutput

type ResourceMapInput 

type ResourceMapInput interface {
	pulumi.Input

	ToResourceMapOutput() ResourceMapOutput
	ToResourceMapOutputWithContext(context.Context) ResourceMapOutput
}

ResourceMapInput is an input type that accepts ResourceMap and ResourceMapOutput values. You can construct a concrete instance of `ResourceMapInput` via: 

ResourceMap{ "key": ResourceArgs{...} }

type ResourceMapOutput 

type ResourceMapOutput struct{ *pulumi.OutputState }

func (ResourceMapOutput) ElementType 

func (ResourceMapOutput) ElementType() reflect.Type

func (ResourceMapOutput) MapIndex 

func (o ResourceMapOutput) MapIndex(k pulumi.StringInput) ResourceOutput

func (ResourceMapOutput) ToOutput added in v6.1.0 

func (o ResourceMapOutput) ToOutput(ctx context.Context) pulumix.Output[map[string]*Resource]

func (ResourceMapOutput) ToResourceMapOutput 

func (o ResourceMapOutput) ToResourceMapOutput() ResourceMapOutput

func (ResourceMapOutput) ToResourceMapOutputWithContext 

func (o ResourceMapOutput) ToResourceMapOutputWithContext(ctx context.Context) ResourceMapOutput

type ResourceOutput 

type ResourceOutput struct{ *pulumi.OutputState }

func (ResourceOutput) DesiredState 

func (o ResourceOutput) DesiredState() pulumi.StringOutput

JSON string matching the CloudFormation resource type schema with desired configuration.

func (ResourceOutput) ElementType 

func (ResourceOutput) ElementType() reflect.Type

func (ResourceOutput) Properties 

func (o ResourceOutput) Properties() pulumi.StringOutput

JSON string matching the CloudFormation resource type schema with current configuration. Underlying attributes can be referenced via the `jsondecode()` function, for example, `jsondecode(data.aws_cloudcontrolapi_resource.example.properties)["example"]`.

func (ResourceOutput) RoleArn 

func (o ResourceOutput) RoleArn() pulumi.StringPtrOutput

Amazon Resource Name (ARN) of the IAM Role to assume for operations.

func (ResourceOutput) Schema 

func (o ResourceOutput) Schema() pulumi.StringOutput

JSON string of the CloudFormation resource type schema which is used for plan time validation where possible. Automatically fetched if not provided. In large scale environments with multiple resources using the same `typeName`, it is recommended to fetch the schema once via the `cloudformation.CloudFormationType` data source and use this argument to reduce `DescribeType` API operation throttling. This value is marked sensitive only to prevent large plan differences from showing.

func (ResourceOutput) ToOutput added in v6.1.0 

func (o ResourceOutput) ToOutput(ctx context.Context) pulumix.Output[*Resource]

func (ResourceOutput) ToResourceOutput 

func (o ResourceOutput) ToResourceOutput() ResourceOutput

func (ResourceOutput) ToResourceOutputWithContext 

func (o ResourceOutput) ToResourceOutputWithContext(ctx context.Context) ResourceOutput

func (ResourceOutput) TypeName 

func (o ResourceOutput) TypeName() pulumi.StringOutput

CloudFormation resource type name. For example, `AWS::EC2::VPC`.

The following arguments are optional:

func (ResourceOutput) TypeVersionId 

func (o ResourceOutput) TypeVersionId() pulumi.StringPtrOutput

Identifier of the CloudFormation resource type version.

type ResourceState 

type ResourceState struct {
	// JSON string matching the CloudFormation resource type schema with desired configuration.
	DesiredState pulumi.StringPtrInput
	// JSON string matching the CloudFormation resource type schema with current configuration. Underlying attributes can be referenced via the `jsondecode()` function, for example, `jsondecode(data.aws_cloudcontrolapi_resource.example.properties)["example"]`.
	Properties pulumi.StringPtrInput
	// Amazon Resource Name (ARN) of the IAM Role to assume for operations.
	RoleArn pulumi.StringPtrInput
	// JSON string of the CloudFormation resource type schema which is used for plan time validation where possible. Automatically fetched if not provided. In large scale environments with multiple resources using the same `typeName`, it is recommended to fetch the schema once via the `cloudformation.CloudFormationType` data source and use this argument to reduce `DescribeType` API operation throttling. This value is marked sensitive only to prevent large plan differences from showing.
	Schema pulumi.StringPtrInput
	// CloudFormation resource type name. For example, `AWS::EC2::VPC`.
	//
	// The following arguments are optional:
	TypeName pulumi.StringPtrInput
	// Identifier of the CloudFormation resource type version.
	TypeVersionId pulumi.StringPtrInput
}

func (ResourceState) ElementType 

func (ResourceState) ElementType() reflect.Type

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.