@pulumi/aws
Version:
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
131 lines (130 loc) • 3.61 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Provides an SSM Parameter data source.
*
* ## Example Usage
*
* ### Default
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.ssm.getParameter({
* name: "foo",
* });
* ```
*
* ### With version
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.ssm.getParameter({
* name: "foo:3",
* });
* ```
*
* > **Note:** The unencrypted value of a SecureString will be stored in the raw state as plain-text.
*/
export declare function getParameter(args: GetParameterArgs, opts?: pulumi.InvokeOptions): Promise<GetParameterResult>;
/**
* A collection of arguments for invoking getParameter.
*/
export interface GetParameterArgs {
/**
* Name of the parameter. To query by parameter version use `name:version` (e.g., `foo:3`).
*/
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;
/**
* Whether to return decrypted `SecureString` value. Defaults to `true`.
*/
withDecryption?: boolean;
}
/**
* A collection of values returned by getParameter.
*/
export interface GetParameterResult {
/**
* ARN of the parameter.
*/
readonly arn: string;
/**
* The provider-assigned unique ID for this managed resource.
*/
readonly id: string;
/**
* Value of the parameter. **Use caution:** This value is never marked as sensitive.
*/
readonly insecureValue: string;
/**
* Name of the parameter.
*/
readonly name: string;
readonly region: string;
/**
* Type of the parameter. Valid types are `String`, `StringList` and `SecureString`.
*/
readonly type: string;
/**
* Value of the parameter. This value is always marked as sensitive in the pulumi preview output, regardless of `type`.
*/
readonly value: string;
/**
* Version of the parameter.
*/
readonly version: number;
readonly withDecryption?: boolean;
}
/**
* Provides an SSM Parameter data source.
*
* ## Example Usage
*
* ### Default
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.ssm.getParameter({
* name: "foo",
* });
* ```
*
* ### With version
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as aws from "@pulumi/aws";
*
* const foo = aws.ssm.getParameter({
* name: "foo:3",
* });
* ```
*
* > **Note:** The unencrypted value of a SecureString will be stored in the raw state as plain-text.
*/
export declare function getParameterOutput(args: GetParameterOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetParameterResult>;
/**
* A collection of arguments for invoking getParameter.
*/
export interface GetParameterOutputArgs {
/**
* Name of the parameter. To query by parameter version use `name:version` (e.g., `foo:3`).
*/
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>;
/**
* Whether to return decrypted `SecureString` value. Defaults to `true`.
*/
withDecryption?: pulumi.Input<boolean>;
}