1. Packages
  2. AWS Classic
  3. API Docs
  4. ssm
  5. getParametersByPath

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.ssm.getParametersByPath

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Using getParametersByPath

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getParametersByPath(args: GetParametersByPathArgs, opts?: InvokeOptions): Promise<GetParametersByPathResult>
    function getParametersByPathOutput(args: GetParametersByPathOutputArgs, opts?: InvokeOptions): Output<GetParametersByPathResult>
    def get_parameters_by_path(path: Optional[str] = None,
                               recursive: Optional[bool] = None,
                               with_decryption: Optional[bool] = None,
                               opts: Optional[InvokeOptions] = None) -> GetParametersByPathResult
    def get_parameters_by_path_output(path: Optional[pulumi.Input[str]] = None,
                               recursive: Optional[pulumi.Input[bool]] = None,
                               with_decryption: Optional[pulumi.Input[bool]] = None,
                               opts: Optional[InvokeOptions] = None) -> Output[GetParametersByPathResult]
    func GetParametersByPath(ctx *Context, args *GetParametersByPathArgs, opts ...InvokeOption) (*GetParametersByPathResult, error)
    func GetParametersByPathOutput(ctx *Context, args *GetParametersByPathOutputArgs, opts ...InvokeOption) GetParametersByPathResultOutput

    > Note: This function is named GetParametersByPath in the Go SDK.

    public static class GetParametersByPath 
    {
        public static Task<GetParametersByPathResult> InvokeAsync(GetParametersByPathArgs args, InvokeOptions? opts = null)
        public static Output<GetParametersByPathResult> Invoke(GetParametersByPathInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetParametersByPathResult> getParametersByPath(GetParametersByPathArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:ssm/getParametersByPath:getParametersByPath
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Path string
    The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Note: If the parameter name (e.g., /my-app/my-param) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., /my-app/my-param/my-actual-param).
    Recursive bool
    Whether to retrieve all parameters within the hirerachy. Defaults to false.
    WithDecryption bool
    Whether to retrieve all parameters in the hierarchy, particularly those of SecureString type, with their value decrypted. Defaults to true.
    Path string
    The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Note: If the parameter name (e.g., /my-app/my-param) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., /my-app/my-param/my-actual-param).
    Recursive bool
    Whether to retrieve all parameters within the hirerachy. Defaults to false.
    WithDecryption bool
    Whether to retrieve all parameters in the hierarchy, particularly those of SecureString type, with their value decrypted. Defaults to true.
    path String
    The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Note: If the parameter name (e.g., /my-app/my-param) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., /my-app/my-param/my-actual-param).
    recursive Boolean
    Whether to retrieve all parameters within the hirerachy. Defaults to false.
    withDecryption Boolean
    Whether to retrieve all parameters in the hierarchy, particularly those of SecureString type, with their value decrypted. Defaults to true.
    path string
    The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Note: If the parameter name (e.g., /my-app/my-param) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., /my-app/my-param/my-actual-param).
    recursive boolean
    Whether to retrieve all parameters within the hirerachy. Defaults to false.
    withDecryption boolean
    Whether to retrieve all parameters in the hierarchy, particularly those of SecureString type, with their value decrypted. Defaults to true.
    path str
    The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Note: If the parameter name (e.g., /my-app/my-param) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., /my-app/my-param/my-actual-param).
    recursive bool
    Whether to retrieve all parameters within the hirerachy. Defaults to false.
    with_decryption bool
    Whether to retrieve all parameters in the hierarchy, particularly those of SecureString type, with their value decrypted. Defaults to true.
    path String
    The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierarchy is the parameter name except the last part of the parameter. The last part of the parameter name can't be in the path. A parameter name hierarchy can have a maximum of 15 levels. Note: If the parameter name (e.g., /my-app/my-param) is specified, the data source will not retrieve any value as designed, unless there are other parameters that happen to use the former path in their hierarchy (e.g., /my-app/my-param/my-actual-param).
    recursive Boolean
    Whether to retrieve all parameters within the hirerachy. Defaults to false.
    withDecryption Boolean
    Whether to retrieve all parameters in the hierarchy, particularly those of SecureString type, with their value decrypted. Defaults to true.

    getParametersByPath Result

    The following output properties are available:

    Arns List<string>
    A list that contains the Amazon Resource Names (ARNs) of the retrieved parameters.
    Id string
    The provider-assigned unique ID for this managed resource.
    Names List<string>
    A list that contains the names of the retrieved parameters.
    Path string
    Types List<string>
    A list that contains the types (String, StringList, or SecureString) of retrieved parameters.
    Values List<string>
    A list that contains the retrieved parameter values. Note: This value is always marked as sensitive in the pulumi preview output, regardless of whether any retrieved parameters are of SecureString type. Use the nonsensitive function to override the behavior at your own risk and discretion, if you are certain that there are no sensitive values being retrieved.
    Recursive bool
    WithDecryption bool
    Arns []string
    A list that contains the Amazon Resource Names (ARNs) of the retrieved parameters.
    Id string
    The provider-assigned unique ID for this managed resource.
    Names []string
    A list that contains the names of the retrieved parameters.
    Path string
    Types []string
    A list that contains the types (String, StringList, or SecureString) of retrieved parameters.
    Values []string
    A list that contains the retrieved parameter values. Note: This value is always marked as sensitive in the pulumi preview output, regardless of whether any retrieved parameters are of SecureString type. Use the nonsensitive function to override the behavior at your own risk and discretion, if you are certain that there are no sensitive values being retrieved.
    Recursive bool
    WithDecryption bool
    arns List<String>
    A list that contains the Amazon Resource Names (ARNs) of the retrieved parameters.
    id String
    The provider-assigned unique ID for this managed resource.
    names List<String>
    A list that contains the names of the retrieved parameters.
    path String
    types List<String>
    A list that contains the types (String, StringList, or SecureString) of retrieved parameters.
    values List<String>
    A list that contains the retrieved parameter values. Note: This value is always marked as sensitive in the pulumi preview output, regardless of whether any retrieved parameters are of SecureString type. Use the nonsensitive function to override the behavior at your own risk and discretion, if you are certain that there are no sensitive values being retrieved.
    recursive Boolean
    withDecryption Boolean
    arns string[]
    A list that contains the Amazon Resource Names (ARNs) of the retrieved parameters.
    id string
    The provider-assigned unique ID for this managed resource.
    names string[]
    A list that contains the names of the retrieved parameters.
    path string
    types string[]
    A list that contains the types (String, StringList, or SecureString) of retrieved parameters.
    values string[]
    A list that contains the retrieved parameter values. Note: This value is always marked as sensitive in the pulumi preview output, regardless of whether any retrieved parameters are of SecureString type. Use the nonsensitive function to override the behavior at your own risk and discretion, if you are certain that there are no sensitive values being retrieved.
    recursive boolean
    withDecryption boolean
    arns Sequence[str]
    A list that contains the Amazon Resource Names (ARNs) of the retrieved parameters.
    id str
    The provider-assigned unique ID for this managed resource.
    names Sequence[str]
    A list that contains the names of the retrieved parameters.
    path str
    types Sequence[str]
    A list that contains the types (String, StringList, or SecureString) of retrieved parameters.
    values Sequence[str]
    A list that contains the retrieved parameter values. Note: This value is always marked as sensitive in the pulumi preview output, regardless of whether any retrieved parameters are of SecureString type. Use the nonsensitive function to override the behavior at your own risk and discretion, if you are certain that there are no sensitive values being retrieved.
    recursive bool
    with_decryption bool
    arns List<String>
    A list that contains the Amazon Resource Names (ARNs) of the retrieved parameters.
    id String
    The provider-assigned unique ID for this managed resource.
    names List<String>
    A list that contains the names of the retrieved parameters.
    path String
    types List<String>
    A list that contains the types (String, StringList, or SecureString) of retrieved parameters.
    values List<String>
    A list that contains the retrieved parameter values. Note: This value is always marked as sensitive in the pulumi preview output, regardless of whether any retrieved parameters are of SecureString type. Use the nonsensitive function to override the behavior at your own risk and discretion, if you are certain that there are no sensitive values being retrieved.
    recursive Boolean
    withDecryption Boolean

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi