ram

package
v1.24.0 Latest Latest
Warning

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

 Go to latest Published: Mar 3, 2020 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

nolint: lll

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetResourceShareFilter added in v1.19.0 

type GetResourceShareFilter struct {
	// The name of the tag key to filter on.
	Name string `pulumi:"name"`
	// The value of the tag key.
	Values []string `pulumi:"values"`
}

type GetResourceShareFilterArgs added in v1.19.0 

type GetResourceShareFilterArgs struct {
	// The name of the tag key to filter on.
	Name pulumi.StringInput `pulumi:"name"`
	// The value of the tag key.
	Values pulumi.StringArrayInput `pulumi:"values"`
}

func (GetResourceShareFilterArgs) ElementType added in v1.19.0 

func (GetResourceShareFilterArgs) ElementType() reflect.Type

func (GetResourceShareFilterArgs) ToGetResourceShareFilterOutput added in v1.19.0 

func (i GetResourceShareFilterArgs) ToGetResourceShareFilterOutput() GetResourceShareFilterOutput

func (GetResourceShareFilterArgs) ToGetResourceShareFilterOutputWithContext added in v1.19.0 

func (i GetResourceShareFilterArgs) ToGetResourceShareFilterOutputWithContext(ctx context.Context) GetResourceShareFilterOutput

type GetResourceShareFilterArray added in v1.19.0 

type GetResourceShareFilterArray []GetResourceShareFilterInput

func (GetResourceShareFilterArray) ElementType added in v1.19.0 

func (GetResourceShareFilterArray) ElementType() reflect.Type

func (GetResourceShareFilterArray) ToGetResourceShareFilterArrayOutput added in v1.19.0 

func (i GetResourceShareFilterArray) ToGetResourceShareFilterArrayOutput() GetResourceShareFilterArrayOutput

func (GetResourceShareFilterArray) ToGetResourceShareFilterArrayOutputWithContext added in v1.19.0 

func (i GetResourceShareFilterArray) ToGetResourceShareFilterArrayOutputWithContext(ctx context.Context) GetResourceShareFilterArrayOutput

type GetResourceShareFilterArrayInput added in v1.19.0 

type GetResourceShareFilterArrayInput interface {
	pulumi.Input

	ToGetResourceShareFilterArrayOutput() GetResourceShareFilterArrayOutput
	ToGetResourceShareFilterArrayOutputWithContext(context.Context) GetResourceShareFilterArrayOutput
}

type GetResourceShareFilterArrayOutput added in v1.19.0 

type GetResourceShareFilterArrayOutput struct{ *pulumi.OutputState }

func (GetResourceShareFilterArrayOutput) ElementType added in v1.19.0 

func (GetResourceShareFilterArrayOutput) ElementType() reflect.Type

func (GetResourceShareFilterArrayOutput) Index added in v1.19.0 

func (o GetResourceShareFilterArrayOutput) Index(i pulumi.IntInput) GetResourceShareFilterOutput

func (GetResourceShareFilterArrayOutput) ToGetResourceShareFilterArrayOutput added in v1.19.0 

func (o GetResourceShareFilterArrayOutput) ToGetResourceShareFilterArrayOutput() GetResourceShareFilterArrayOutput

func (GetResourceShareFilterArrayOutput) ToGetResourceShareFilterArrayOutputWithContext added in v1.19.0 

func (o GetResourceShareFilterArrayOutput) ToGetResourceShareFilterArrayOutputWithContext(ctx context.Context) GetResourceShareFilterArrayOutput

type GetResourceShareFilterInput added in v1.19.0 

type GetResourceShareFilterInput interface {
	pulumi.Input

	ToGetResourceShareFilterOutput() GetResourceShareFilterOutput
	ToGetResourceShareFilterOutputWithContext(context.Context) GetResourceShareFilterOutput
}

type GetResourceShareFilterOutput added in v1.19.0 

type GetResourceShareFilterOutput struct{ *pulumi.OutputState }

func (GetResourceShareFilterOutput) ElementType added in v1.19.0 

func (GetResourceShareFilterOutput) ElementType() reflect.Type

func (GetResourceShareFilterOutput) Name added in v1.19.0 

func (o GetResourceShareFilterOutput) Name() pulumi.StringOutput

The name of the tag key to filter on.

func (GetResourceShareFilterOutput) ToGetResourceShareFilterOutput added in v1.19.0 

func (o GetResourceShareFilterOutput) ToGetResourceShareFilterOutput() GetResourceShareFilterOutput

func (GetResourceShareFilterOutput) ToGetResourceShareFilterOutputWithContext added in v1.19.0 

func (o GetResourceShareFilterOutput) ToGetResourceShareFilterOutputWithContext(ctx context.Context) GetResourceShareFilterOutput

func (GetResourceShareFilterOutput) Values added in v1.19.0 

func (o GetResourceShareFilterOutput) Values() pulumi.StringArrayOutput

The value of the tag key.

type LookupResourceShareArgs added in v1.19.0 

type LookupResourceShareArgs struct {
	// A filter used to scope the list e.g. by tags. See [related docs] (https://docs.aws.amazon.com/ram/latest/APIReference/API_TagFilter.html).
	Filters []GetResourceShareFilter `pulumi:"filters"`
	// The name of the tag key to filter on.
	Name string `pulumi:"name"`
	// The owner of the resource share. Valid values are SELF or OTHER-ACCOUNTS
	ResourceOwner string                 `pulumi:"resourceOwner"`
	Tags          map[string]interface{} `pulumi:"tags"`
}

A collection of arguments for invoking getResourceShare.

type LookupResourceShareResult added in v1.19.0 

type LookupResourceShareResult struct {
	// The Amazon Resource Name (ARN) of the resource share.
	Arn     string                   `pulumi:"arn"`
	Filters []GetResourceShareFilter `pulumi:"filters"`
	// The Amazon Resource Name (ARN) of the resource share.
	Id            string `pulumi:"id"`
	Name          string `pulumi:"name"`
	ResourceOwner string `pulumi:"resourceOwner"`
	// The Status of the RAM share.
	Status string `pulumi:"status"`
	// The Tags attached to the RAM share
	Tags map[string]interface{} `pulumi:"tags"`
}

A collection of values returned by getResourceShare.

func LookupResourceShare added in v0.18.4 

func LookupResourceShare(ctx *pulumi.Context, args *LookupResourceShareArgs, opts ...pulumi.InvokeOption) (*LookupResourceShareResult, error)

`ram.ResourceShare` Retrieve information about a RAM Resource Share.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/d/ram_resource_share.html.markdown.

type PrincipalAssociation added in v0.16.9 

type PrincipalAssociation struct {
	pulumi.CustomResourceState

	// The principal to associate with the resource share. Possible values are an AWS account ID, an AWS Organizations Organization ARN, or an AWS Organizations Organization Unit ARN.
	Principal pulumi.StringOutput `pulumi:"principal"`
	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn pulumi.StringOutput `pulumi:"resourceShareArn"`
}

Provides a Resource Access Manager (RAM) principal association. Depending if [RAM Sharing with AWS Organizations is enabled](https://docs.aws.amazon.com/ram/latest/userguide/getting-started-sharing.html#getting-started-sharing-orgs), the RAM behavior with different principal types changes.

When RAM Sharing with AWS Organizations is enabled:

- For AWS Account ID, Organization, and Organizational Unit principals within the same AWS Organization, no resource share invitation is sent and resources become available automatically after creating the association. - For AWS Account ID principals outside the AWS Organization, a resource share invitation is sent and must be accepted before resources become available. See the [`ram.ResourceShareAccepter` resource](https://www.terraform.io/docs/providers/aws/r/ram_resource_share_accepter.html) to accept these invitations.

When RAM Sharing with AWS Organizations is not enabled:

- Organization and Organizational Unit principals cannot be used. - For AWS Account ID principals, a resource share invitation is sent and must be accepted before resources become available. See the [`ram.ResourceShareAccepter` resource](https://www.terraform.io/docs/providers/aws/r/ram_resource_share_accepter.html) to accept these invitations.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/ram_principal_association.html.markdown.

func GetPrincipalAssociation added in v0.16.9 

func GetPrincipalAssociation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *PrincipalAssociationState, opts ...pulumi.ResourceOption) (*PrincipalAssociation, error)

GetPrincipalAssociation gets an existing PrincipalAssociation 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 NewPrincipalAssociation added in v0.16.9 

func NewPrincipalAssociation(ctx *pulumi.Context,
	name string, args *PrincipalAssociationArgs, opts ...pulumi.ResourceOption) (*PrincipalAssociation, error)

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

type PrincipalAssociationArgs added in v0.16.9 

type PrincipalAssociationArgs struct {
	// The principal to associate with the resource share. Possible values are an AWS account ID, an AWS Organizations Organization ARN, or an AWS Organizations Organization Unit ARN.
	Principal pulumi.StringInput
	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn pulumi.StringInput
}

The set of arguments for constructing a PrincipalAssociation resource.

func (PrincipalAssociationArgs) ElementType added in v1.19.0 

func (PrincipalAssociationArgs) ElementType() reflect.Type

type PrincipalAssociationState added in v0.16.9 

type PrincipalAssociationState struct {
	// The principal to associate with the resource share. Possible values are an AWS account ID, an AWS Organizations Organization ARN, or an AWS Organizations Organization Unit ARN.
	Principal pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn pulumi.StringPtrInput
}

func (PrincipalAssociationState) ElementType added in v1.19.0 

func (PrincipalAssociationState) ElementType() reflect.Type

type ResourceAssociation added in v0.16.9 

type ResourceAssociation struct {
	pulumi.CustomResourceState

	// Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share.
	ResourceArn pulumi.StringOutput `pulumi:"resourceArn"`
	// Amazon Resource Name (ARN) of the RAM Resource Share.
	ResourceShareArn pulumi.StringOutput `pulumi:"resourceShareArn"`
}

Manages a Resource Access Manager (RAM) Resource Association.

> *NOTE:* Certain AWS resources (e.g. EC2 Subnets) can only be shared in an AWS account that is a member of an AWS Organizations organization with organization-wide Resource Access Manager functionality enabled. See the [Resource Access Manager User Guide](https://docs.aws.amazon.com/ram/latest/userguide/what-is.html) and AWS service specific documentation for additional information.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/ram_resource_association.html.markdown.

func GetResourceAssociation added in v0.16.9 

func GetResourceAssociation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourceAssociationState, opts ...pulumi.ResourceOption) (*ResourceAssociation, error)

GetResourceAssociation gets an existing ResourceAssociation 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 NewResourceAssociation added in v0.16.9 

func NewResourceAssociation(ctx *pulumi.Context,
	name string, args *ResourceAssociationArgs, opts ...pulumi.ResourceOption) (*ResourceAssociation, error)

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

type ResourceAssociationArgs added in v0.16.9 

type ResourceAssociationArgs struct {
	// Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share.
	ResourceArn pulumi.StringInput
	// Amazon Resource Name (ARN) of the RAM Resource Share.
	ResourceShareArn pulumi.StringInput
}

The set of arguments for constructing a ResourceAssociation resource.

func (ResourceAssociationArgs) ElementType added in v1.19.0 

func (ResourceAssociationArgs) ElementType() reflect.Type

type ResourceAssociationState added in v0.16.9 

type ResourceAssociationState struct {
	// Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share.
	ResourceArn pulumi.StringPtrInput
	// Amazon Resource Name (ARN) of the RAM Resource Share.
	ResourceShareArn pulumi.StringPtrInput
}

func (ResourceAssociationState) ElementType added in v1.19.0 

func (ResourceAssociationState) ElementType() reflect.Type

type ResourceShare 

type ResourceShare struct {
	pulumi.CustomResourceState

	// Indicates whether principals outside your organization can be associated with a resource share.
	AllowExternalPrincipals pulumi.BoolPtrOutput `pulumi:"allowExternalPrincipals"`
	// The Amazon Resource Name (ARN) of the resource share.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The name of the resource share.
	Name pulumi.StringOutput `pulumi:"name"`
	// A mapping of tags to assign to the resource share.
	Tags pulumi.MapOutput `pulumi:"tags"`
}

Manages a Resource Access Manager (RAM) Resource Share. To association principals with the share, see the [`ram.PrincipalAssociation` resource](https://www.terraform.io/docs/providers/aws/r/ram_principal_association.html). To associate resources with the share, see the [`ram.ResourceAssociation` resource](https://www.terraform.io/docs/providers/aws/r/ram_resource_association.html).

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/ram_resource_share.html.markdown.

func GetResourceShare 

func GetResourceShare(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourceShareState, opts ...pulumi.ResourceOption) (*ResourceShare, error)

GetResourceShare gets an existing ResourceShare 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 NewResourceShare 

func NewResourceShare(ctx *pulumi.Context,
	name string, args *ResourceShareArgs, opts ...pulumi.ResourceOption) (*ResourceShare, error)

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

type ResourceShareAccepter added in v1.0.0 

type ResourceShareAccepter struct {
	pulumi.CustomResourceState

	// The ARN of the resource share invitation.
	InvitationArn pulumi.StringOutput `pulumi:"invitationArn"`
	// The account ID of the receiver account which accepts the invitation.
	ReceiverAccountId pulumi.StringOutput `pulumi:"receiverAccountId"`
	// A list of the resource ARNs shared via the resource share.
	Resources pulumi.StringArrayOutput `pulumi:"resources"`
	// The account ID of the sender account which submits the invitation.
	SenderAccountId pulumi.StringOutput `pulumi:"senderAccountId"`
	// The ARN of the resource share.
	ShareArn pulumi.StringOutput `pulumi:"shareArn"`
	// The ID of the resource share as displayed in the console.
	ShareId pulumi.StringOutput `pulumi:"shareId"`
	// The name of the resource share.
	ShareName pulumi.StringOutput `pulumi:"shareName"`
	// The status of the resource share (ACTIVE, PENDING, FAILED, DELETING, DELETED).
	Status pulumi.StringOutput `pulumi:"status"`
}

Manage accepting a Resource Access Manager (RAM) Resource Share invitation. From a _receiver_ AWS account, accept an invitation to share resources that were shared by a _sender_ AWS account. To create a resource share in the _sender_, see the [`ram.ResourceShare` resource](https://www.terraform.io/docs/providers/aws/r/ram_resource_share.html).

> **Note:** If both AWS accounts are in the same Organization and [RAM Sharing with AWS Organizations is enabled](https://docs.aws.amazon.com/ram/latest/userguide/getting-started-sharing.html#getting-started-sharing-orgs), this resource is not necessary as RAM Resource Share invitations are not used.

> This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/ram_resource_share_accepter.html.markdown.

func GetResourceShareAccepter added in v1.0.0 

func GetResourceShareAccepter(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *ResourceShareAccepterState, opts ...pulumi.ResourceOption) (*ResourceShareAccepter, error)

GetResourceShareAccepter gets an existing ResourceShareAccepter 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 NewResourceShareAccepter added in v1.0.0 

func NewResourceShareAccepter(ctx *pulumi.Context,
	name string, args *ResourceShareAccepterArgs, opts ...pulumi.ResourceOption) (*ResourceShareAccepter, error)

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

type ResourceShareAccepterArgs added in v1.0.0 

type ResourceShareAccepterArgs struct {
	// The ARN of the resource share.
	ShareArn pulumi.StringInput
}

The set of arguments for constructing a ResourceShareAccepter resource.

func (ResourceShareAccepterArgs) ElementType added in v1.19.0 

func (ResourceShareAccepterArgs) ElementType() reflect.Type

type ResourceShareAccepterState added in v1.0.0 

type ResourceShareAccepterState struct {
	// The ARN of the resource share invitation.
	InvitationArn pulumi.StringPtrInput
	// The account ID of the receiver account which accepts the invitation.
	ReceiverAccountId pulumi.StringPtrInput
	// A list of the resource ARNs shared via the resource share.
	Resources pulumi.StringArrayInput
	// The account ID of the sender account which submits the invitation.
	SenderAccountId pulumi.StringPtrInput
	// The ARN of the resource share.
	ShareArn pulumi.StringPtrInput
	// The ID of the resource share as displayed in the console.
	ShareId pulumi.StringPtrInput
	// The name of the resource share.
	ShareName pulumi.StringPtrInput
	// The status of the resource share (ACTIVE, PENDING, FAILED, DELETING, DELETED).
	Status pulumi.StringPtrInput
}

func (ResourceShareAccepterState) ElementType added in v1.19.0 

func (ResourceShareAccepterState) ElementType() reflect.Type

type ResourceShareArgs 

type ResourceShareArgs struct {
	// Indicates whether principals outside your organization can be associated with a resource share.
	AllowExternalPrincipals pulumi.BoolPtrInput
	// The name of the resource share.
	Name pulumi.StringPtrInput
	// A mapping of tags to assign to the resource share.
	Tags pulumi.MapInput
}

The set of arguments for constructing a ResourceShare resource.

func (ResourceShareArgs) ElementType added in v1.19.0 

func (ResourceShareArgs) ElementType() reflect.Type

type ResourceShareState 

type ResourceShareState struct {
	// Indicates whether principals outside your organization can be associated with a resource share.
	AllowExternalPrincipals pulumi.BoolPtrInput
	// The Amazon Resource Name (ARN) of the resource share.
	Arn pulumi.StringPtrInput
	// The name of the resource share.
	Name pulumi.StringPtrInput
	// A mapping of tags to assign to the resource share.
	Tags pulumi.MapInput
}

func (ResourceShareState) ElementType added in v1.19.0 

func (ResourceShareState) 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.