ram

package
v1.10.0 Latest Latest
Warning

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

 Go to latest Published: Nov 19, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

nolint: lll Package ram exports types, functions, subpackages for provisioning ram resources.

> This provider is a derived work of the [Terraform Provider](https://github.com/terraform-providers/terraform-provider-aws) > distributed under [MPL 2.0](https://www.mozilla.org/en-US/MPL/2.0/). If you encounter a bug or missing feature, > first check the [`pulumi/pulumi-aws` repo](https://github.com/pulumi/pulumi-aws/issues); however, if that doesn't turn up anything, > please consult the source [`terraform-providers/terraform-provider-aws` repo](https://github.com/terraform-providers/terraform-provider-aws/issues).

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetResourceShareArgs added in v0.18.4 

type GetResourceShareArgs 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 interface{}
	// The name of the tag key to filter on.
	Name interface{}
	// The owner of the resource share. Valid values are SELF or OTHER-ACCOUNTS
	ResourceOwner interface{}
}

A collection of arguments for invoking getResourceShare.

type GetResourceShareResult added in v0.18.4 

type GetResourceShareResult struct {
	// The Amazon Resource Name (ARN) of the resource share.
	Arn     interface{}
	Filters interface{}
	// The Amazon Resource Name (ARN) of the resource share.
	Id            interface{}
	Name          interface{}
	ResourceOwner interface{}
	// The Status of the RAM share.
	Status interface{}
	// The Tags attached to the RAM share
	Tags interface{}
}

A collection of values returned by getResourceShare.

func LookupResourceShare added in v0.18.4 

func LookupResourceShare(ctx *pulumi.Context, args *GetResourceShareArgs) (*GetResourceShareResult, 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 {
	// contains filtered or unexported fields
}

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.ID, state *PrincipalAssociationState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*PrincipalAssociation, error)

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

func (*PrincipalAssociation) ID added in v0.16.9 

func (r *PrincipalAssociation) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*PrincipalAssociation) Principal added in v0.16.9 

func (r *PrincipalAssociation) Principal() *pulumi.StringOutput

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.

func (*PrincipalAssociation) ResourceShareArn added in v0.16.9 

func (r *PrincipalAssociation) ResourceShareArn() *pulumi.StringOutput

The Amazon Resource Name (ARN) of the resource share.

func (*PrincipalAssociation) URN added in v0.16.9 

func (r *PrincipalAssociation) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

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 interface{}
	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn interface{}
}

The set of arguments for constructing a PrincipalAssociation resource.

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 interface{}
	// The Amazon Resource Name (ARN) of the resource share.
	ResourceShareArn interface{}
}

Input properties used for looking up and filtering PrincipalAssociation resources.

type ResourceAssociation added in v0.16.9 

type ResourceAssociation struct {
	// contains filtered or unexported fields
}

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.ID, state *ResourceAssociationState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*ResourceAssociation, error)

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

func (*ResourceAssociation) ID added in v0.16.9 

func (r *ResourceAssociation) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ResourceAssociation) ResourceArn added in v0.16.9 

func (r *ResourceAssociation) ResourceArn() *pulumi.StringOutput

Amazon Resource Name (ARN) of the resource to associate with the RAM Resource Share.

func (*ResourceAssociation) ResourceShareArn added in v0.16.9 

func (r *ResourceAssociation) ResourceShareArn() *pulumi.StringOutput

Amazon Resource Name (ARN) of the RAM Resource Share.

func (*ResourceAssociation) URN added in v0.16.9 

func (r *ResourceAssociation) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

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 interface{}
	// Amazon Resource Name (ARN) of the RAM Resource Share.
	ResourceShareArn interface{}
}

The set of arguments for constructing a ResourceAssociation resource.

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 interface{}
	// Amazon Resource Name (ARN) of the RAM Resource Share.
	ResourceShareArn interface{}
}

Input properties used for looking up and filtering ResourceAssociation resources.

type ResourceShare 

type ResourceShare struct {
	// contains filtered or unexported fields
}

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.ID, state *ResourceShareState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*ResourceShare, error)

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

func (*ResourceShare) AllowExternalPrincipals 

func (r *ResourceShare) AllowExternalPrincipals() *pulumi.BoolOutput

Indicates whether principals outside your organization can be associated with a resource share.

func (*ResourceShare) Arn added in v0.18.0 

func (r *ResourceShare) Arn() *pulumi.StringOutput

The Amazon Resource Name (ARN) of the resource share.

func (*ResourceShare) ID 

func (r *ResourceShare) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ResourceShare) Name 

func (r *ResourceShare) Name() *pulumi.StringOutput

The name of the resource share.

func (*ResourceShare) Tags 

func (r *ResourceShare) Tags() *pulumi.MapOutput

A mapping of tags to assign to the resource share.

func (*ResourceShare) URN 

func (r *ResourceShare) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ResourceShareAccepter added in v1.0.0 

type ResourceShareAccepter struct {
	// contains filtered or unexported fields
}

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.ID, state *ResourceShareAccepterState, opts ...pulumi.ResourceOpt) (*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.ResourceOpt) (*ResourceShareAccepter, error)

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

func (*ResourceShareAccepter) ID added in v1.0.0 

func (r *ResourceShareAccepter) ID() *pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ResourceShareAccepter) InvitationArn added in v1.0.0 

func (r *ResourceShareAccepter) InvitationArn() *pulumi.StringOutput

The ARN of the resource share invitation.

func (*ResourceShareAccepter) ReceiverAccountId added in v1.0.0 

func (r *ResourceShareAccepter) ReceiverAccountId() *pulumi.StringOutput

The account ID of the receiver account which accepts the invitation.

func (*ResourceShareAccepter) Resources added in v1.0.0 

func (r *ResourceShareAccepter) Resources() *pulumi.ArrayOutput

A list of the resource ARNs shared via the resource share.

func (*ResourceShareAccepter) SenderAccountId added in v1.0.0 

func (r *ResourceShareAccepter) SenderAccountId() *pulumi.StringOutput

The account ID of the sender account which extends the invitation.

func (*ResourceShareAccepter) ShareArn added in v1.0.0 

func (r *ResourceShareAccepter) ShareArn() *pulumi.StringOutput

The ARN of the resource share.

func (*ResourceShareAccepter) ShareId added in v1.0.0 

func (r *ResourceShareAccepter) ShareId() *pulumi.StringOutput

The ID of the resource share as displayed in the console.

func (*ResourceShareAccepter) ShareName added in v1.0.0 

func (r *ResourceShareAccepter) ShareName() *pulumi.StringOutput

The name of the resource share.

func (*ResourceShareAccepter) Status added in v1.0.0 

func (r *ResourceShareAccepter) Status() *pulumi.StringOutput

The status of the invitation (e.g., ACCEPTED, REJECTED).

func (*ResourceShareAccepter) URN added in v1.0.0 

func (r *ResourceShareAccepter) URN() *pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ResourceShareAccepterArgs added in v1.0.0 

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

The set of arguments for constructing a ResourceShareAccepter resource.

type ResourceShareAccepterState added in v1.0.0 

type ResourceShareAccepterState struct {
	// The ARN of the resource share invitation.
	InvitationArn interface{}
	// The account ID of the receiver account which accepts the invitation.
	ReceiverAccountId interface{}
	// A list of the resource ARNs shared via the resource share.
	Resources interface{}
	// The account ID of the sender account which extends the invitation.
	SenderAccountId interface{}
	// The ARN of the resource share.
	ShareArn interface{}
	// The ID of the resource share as displayed in the console.
	ShareId interface{}
	// The name of the resource share.
	ShareName interface{}
	// The status of the invitation (e.g., ACCEPTED, REJECTED).
	Status interface{}
}

Input properties used for looking up and filtering ResourceShareAccepter resources.

type ResourceShareArgs 

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

The set of arguments for constructing a ResourceShare resource.

type ResourceShareState 

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

Input properties used for looking up and filtering ResourceShare resources.

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.