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 ¶
- type GetResourceShareArgs
- type GetResourceShareResult
- type PrincipalAssociation
- type PrincipalAssociationArgs
- type PrincipalAssociationState
- type ResourceAssociation
- type ResourceAssociationArgs
- type ResourceAssociationState
- type ResourceShare
- func (r *ResourceShare) AllowExternalPrincipals() *pulumi.BoolOutput
- func (r *ResourceShare) Arn() *pulumi.StringOutput
- func (r *ResourceShare) ID() *pulumi.IDOutput
- func (r *ResourceShare) Name() *pulumi.StringOutput
- func (r *ResourceShare) Tags() *pulumi.MapOutput
- func (r *ResourceShare) URN() *pulumi.URNOutput
- type ResourceShareArgs
- type ResourceShareState
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 {Filters interface{} Name interface{} 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. // The Amazon Resource Name (ARN) of the resource share. Status interface{} 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.
> *NOTE:* For an AWS Account ID principal, the target account must accept the RAM association invitation after resource creation.
> 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{} 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{} 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{} 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{} 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 ResourceShareArgs ¶
type ResourceShareArgs struct {AllowExternalPrincipals interface{} Name interface{} Tags interface{} }
The set of arguments for constructing a ResourceShare resource.
type ResourceShareState ¶
type ResourceShareState struct {AllowExternalPrincipals interface{} Arn interface{} Name interface{} Tags interface{} }
Input properties used for looking up and filtering ResourceShare resources.