Class GetAmiPlainArgs.Builder

  • Enclosing class:
    GetAmiPlainArgs

    public static final class GetAmiPlainArgs.Builder
    extends java.lang.Object
    • Constructor Detail

      • Builder

        public Builder()
    • Method Detail

      • allowUnsafeFilter

        public GetAmiPlainArgs.Builder allowUnsafeFilter​(@Nullable
                                                         java.lang.Boolean allowUnsafeFilter)
        Parameters:
        allowUnsafeFilter - If true, allow unsafe filter values. With unsafe filters and `mostRecent` set to `true`, a third party may introduce a new image which will be returned by this data source. Consider filtering by owner or image ID rather than setting this argument.
        Returns:
        builder
      • executableUsers

        public GetAmiPlainArgs.Builder executableUsers​(@Nullable
                                                       java.util.List<java.lang.String> executableUsers)
        Parameters:
        executableUsers - Limit search to users with *explicit* launch permission on the image. Valid items are the numeric account ID or `self`.
        Returns:
        builder
      • executableUsers

        public GetAmiPlainArgs.Builder executableUsers​(java.lang.String... executableUsers)
        Parameters:
        executableUsers - Limit search to users with *explicit* launch permission on the image. Valid items are the numeric account ID or `self`.
        Returns:
        builder
      • filters

        public GetAmiPlainArgs.Builder filters​(@Nullable
                                               java.util.List<GetAmiFilter> filters)
        Parameters:
        filters - One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference](http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html). See `filter` below.
        Returns:
        builder
      • filters

        public GetAmiPlainArgs.Builder filters​(GetAmiFilter... filters)
        Parameters:
        filters - One or more name/value pairs to filter off of. There are several valid keys, for a full reference, check out [describe-images in the AWS CLI reference](http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html). See `filter` below.
        Returns:
        builder
      • includeDeprecated

        public GetAmiPlainArgs.Builder includeDeprecated​(@Nullable
                                                         java.lang.Boolean includeDeprecated)
        Parameters:
        includeDeprecated - If true, all deprecated AMIs are included in the response. If false, no deprecated AMIs are included in the response. If no value is specified, the default value is false.
        Returns:
        builder
      • mostRecent

        public GetAmiPlainArgs.Builder mostRecent​(@Nullable
                                                  java.lang.Boolean mostRecent)
        Parameters:
        mostRecent - If more than one result is returned, use the most recent AMI.
        Returns:
        builder
      • nameRegex

        public GetAmiPlainArgs.Builder nameRegex​(@Nullable
                                                 java.lang.String nameRegex)
        Parameters:
        nameRegex - Regex string to apply to the AMI list returned by AWS. This allows more advanced filtering not supported from the AWS API. This filtering is done locally on what AWS returns, and could have a performance impact if the result is large. Combine this with other options to narrow down the list AWS returns.
        Returns:
        builder
      • owners

        public GetAmiPlainArgs.Builder owners​(@Nullable
                                              java.util.List<java.lang.String> owners)
        Parameters:
        owners - List of AMI owners to limit search. Valid values: an AWS account ID, `self` (the current account), or an AWS owner alias (e.g., `amazon`, `aws-marketplace`, `microsoft`).
        Returns:
        builder
      • owners

        public GetAmiPlainArgs.Builder owners​(java.lang.String... owners)
        Parameters:
        owners - List of AMI owners to limit search. Valid values: an AWS account ID, `self` (the current account), or an AWS owner alias (e.g., `amazon`, `aws-marketplace`, `microsoft`).
        Returns:
        builder
      • region

        public GetAmiPlainArgs.Builder region​(@Nullable
                                              java.lang.String region)
        Parameters:
        region - 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.
        Returns:
        builder
      • tags

        public GetAmiPlainArgs.Builder tags​(@Nullable
                                            java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - Any tags assigned to the image.
        Returns:
        builder
      • uefiData

        public GetAmiPlainArgs.Builder uefiData​(@Nullable
                                                java.lang.String uefiData)
        Parameters:
        uefiData - Base64 representation of the non-volatile UEFI variable store. > **NOTE:** If more or less than a single match is returned by the search, this call will fail. Ensure that your search is specific enough to return a single AMI ID only, or use `mostRecent` to choose the most recent one. If you want to match multiple AMIs, use the `aws.ec2.getAmiIds` data source instead.
        Returns:
        builder