@pulumi/aws/ram/getResourceShare.d.ts

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
 * `aws.ram.ResourceShare` Retrieve information about a RAM Resource Share.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.ram.getResourceShare({
 *     name: "example",
 *     resourceOwner: "SELF",
 * });
 * ```
 *
 * ## Search by filters
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const tagFilter = aws.ram.getResourceShare({
 *     resourceOwner: "SELF",
 *     filters: [{
 *         name: "NameOfTag",
 *         values: ["exampleNameTagValue"],
 *     }],
 * });
 * ```
 */
export declare function getResourceShare(args: GetResourceShareArgs, opts?: pulumi.InvokeOptions): Promise<GetResourceShareResult>;
/**
 * A collection of arguments for invoking getResourceShare.
 */
export interface GetResourceShareArgs {
    /**
     * Filter used to scope the list of owned shares e.g., by tags. See [related docs] (https://docs.aws.amazon.com/ram/latest/APIReference/API_TagFilter.html).
     */
    filters?: inputs.ram.GetResourceShareFilter[];
    /**
     * Name of the resource share to retrieve.
     */
    name?: string;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: string;
    /**
     * Owner of the resource share. Valid values are `SELF` or `OTHER-ACCOUNTS`.
     */
    resourceOwner: string;
    /**
     * Specifies that you want to retrieve details of only those resource shares that have this status. Valid values are `PENDING`, `ACTIVE`, `FAILED`, `DELETING`, and `DELETED`.
     */
    resourceShareStatus?: string;
    /**
     * Tags attached to the resource share.
     */
    tags?: {
        [key: string]: string;
    };
}
/**
 * A collection of values returned by getResourceShare.
 */
export interface GetResourceShareResult {
    /**
     * ARN of the resource share.
     */
    readonly arn: string;
    readonly filters?: outputs.ram.GetResourceShareFilter[];
    /**
     * The provider-assigned unique ID for this managed resource.
     */
    readonly id: string;
    readonly name: string;
    /**
     * ID of the AWS account that owns the resource share.
     */
    readonly owningAccountId: string;
    readonly region: string;
    /**
     * A list of resource ARNs associated with the resource share.
     */
    readonly resourceArns: string[];
    readonly resourceOwner: string;
    readonly resourceShareStatus?: string;
    /**
     * Status of the resource share.
     */
    readonly status: string;
    /**
     * Tags attached to the resource share.
     */
    readonly tags: {
        [key: string]: string;
    };
}
/**
 * `aws.ram.ResourceShare` Retrieve information about a RAM Resource Share.
 *
 * ## Example Usage
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const example = aws.ram.getResourceShare({
 *     name: "example",
 *     resourceOwner: "SELF",
 * });
 * ```
 *
 * ## Search by filters
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as aws from "@pulumi/aws";
 *
 * const tagFilter = aws.ram.getResourceShare({
 *     resourceOwner: "SELF",
 *     filters: [{
 *         name: "NameOfTag",
 *         values: ["exampleNameTagValue"],
 *     }],
 * });
 * ```
 */
export declare function getResourceShareOutput(args: GetResourceShareOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetResourceShareResult>;
/**
 * A collection of arguments for invoking getResourceShare.
 */
export interface GetResourceShareOutputArgs {
    /**
     * Filter used to scope the list of owned shares e.g., by tags. See [related docs] (https://docs.aws.amazon.com/ram/latest/APIReference/API_TagFilter.html).
     */
    filters?: pulumi.Input<pulumi.Input<inputs.ram.GetResourceShareFilterArgs>[]>;
    /**
     * Name of the resource share to retrieve.
     */
    name?: pulumi.Input<string>;
    /**
     * Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
     */
    region?: pulumi.Input<string>;
    /**
     * Owner of the resource share. Valid values are `SELF` or `OTHER-ACCOUNTS`.
     */
    resourceOwner: pulumi.Input<string>;
    /**
     * Specifies that you want to retrieve details of only those resource shares that have this status. Valid values are `PENDING`, `ACTIVE`, `FAILED`, `DELETING`, and `DELETED`.
     */
    resourceShareStatus?: pulumi.Input<string>;
    /**
     * Tags attached to the resource share.
     */
    tags?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
}