1. Packages
  2. Google Cloud Native
  3. API Docs
  4. apigee
  5. apigee/v1
  6. getSecurityAction

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.apigee/v1.getSecurityAction

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

    Get a SecurityAction by name.

    Using getSecurityAction

    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 getSecurityAction(args: GetSecurityActionArgs, opts?: InvokeOptions): Promise<GetSecurityActionResult>
    function getSecurityActionOutput(args: GetSecurityActionOutputArgs, opts?: InvokeOptions): Output<GetSecurityActionResult>
    def get_security_action(environment_id: Optional[str] = None,
                            organization_id: Optional[str] = None,
                            security_action_id: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetSecurityActionResult
    def get_security_action_output(environment_id: Optional[pulumi.Input[str]] = None,
                            organization_id: Optional[pulumi.Input[str]] = None,
                            security_action_id: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetSecurityActionResult]
    func LookupSecurityAction(ctx *Context, args *LookupSecurityActionArgs, opts ...InvokeOption) (*LookupSecurityActionResult, error)
    func LookupSecurityActionOutput(ctx *Context, args *LookupSecurityActionOutputArgs, opts ...InvokeOption) LookupSecurityActionResultOutput

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

    public static class GetSecurityAction 
    {
        public static Task<GetSecurityActionResult> InvokeAsync(GetSecurityActionArgs args, InvokeOptions? opts = null)
        public static Output<GetSecurityActionResult> Invoke(GetSecurityActionInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSecurityActionResult> getSecurityAction(GetSecurityActionArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: google-native:apigee/v1:getSecurityAction
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getSecurityAction Result

    The following output properties are available:

    Allow Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityActionAllowResponse
    Allow a request through if it matches this SecurityAction.
    ConditionConfig Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityActionConditionConfigResponse
    A valid SecurityAction must contain at least one condition.
    CreateTime string
    The create time for this SecurityAction.
    Deny Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityActionDenyResponse
    Deny a request through if it matches this SecurityAction.
    Description string
    Optional. An optional user provided description of the SecurityAction.
    ExpireTime string
    The expiration for this SecurityAction.
    Flag Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityActionFlagResponse
    Flag a request through if it matches this SecurityAction.
    Name string
    Immutable. This field is ignored during creation as per AIP-133. Please set the security_action_id field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
    State string
    Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
    Ttl string
    Input only. The TTL for this SecurityAction.
    UpdateTime string
    The update time for this SecurityAction. This reflects when this SecurityAction changed states.
    Allow GoogleCloudApigeeV1SecurityActionAllowResponse
    Allow a request through if it matches this SecurityAction.
    ConditionConfig GoogleCloudApigeeV1SecurityActionConditionConfigResponse
    A valid SecurityAction must contain at least one condition.
    CreateTime string
    The create time for this SecurityAction.
    Deny GoogleCloudApigeeV1SecurityActionDenyResponse
    Deny a request through if it matches this SecurityAction.
    Description string
    Optional. An optional user provided description of the SecurityAction.
    ExpireTime string
    The expiration for this SecurityAction.
    Flag GoogleCloudApigeeV1SecurityActionFlagResponse
    Flag a request through if it matches this SecurityAction.
    Name string
    Immutable. This field is ignored during creation as per AIP-133. Please set the security_action_id field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
    State string
    Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
    Ttl string
    Input only. The TTL for this SecurityAction.
    UpdateTime string
    The update time for this SecurityAction. This reflects when this SecurityAction changed states.
    allow GoogleCloudApigeeV1SecurityActionAllowResponse
    Allow a request through if it matches this SecurityAction.
    conditionConfig GoogleCloudApigeeV1SecurityActionConditionConfigResponse
    A valid SecurityAction must contain at least one condition.
    createTime String
    The create time for this SecurityAction.
    deny GoogleCloudApigeeV1SecurityActionDenyResponse
    Deny a request through if it matches this SecurityAction.
    description String
    Optional. An optional user provided description of the SecurityAction.
    expireTime String
    The expiration for this SecurityAction.
    flag GoogleCloudApigeeV1SecurityActionFlagResponse
    Flag a request through if it matches this SecurityAction.
    name String
    Immutable. This field is ignored during creation as per AIP-133. Please set the security_action_id field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
    state String
    Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
    ttl String
    Input only. The TTL for this SecurityAction.
    updateTime String
    The update time for this SecurityAction. This reflects when this SecurityAction changed states.
    allow GoogleCloudApigeeV1SecurityActionAllowResponse
    Allow a request through if it matches this SecurityAction.
    conditionConfig GoogleCloudApigeeV1SecurityActionConditionConfigResponse
    A valid SecurityAction must contain at least one condition.
    createTime string
    The create time for this SecurityAction.
    deny GoogleCloudApigeeV1SecurityActionDenyResponse
    Deny a request through if it matches this SecurityAction.
    description string
    Optional. An optional user provided description of the SecurityAction.
    expireTime string
    The expiration for this SecurityAction.
    flag GoogleCloudApigeeV1SecurityActionFlagResponse
    Flag a request through if it matches this SecurityAction.
    name string
    Immutable. This field is ignored during creation as per AIP-133. Please set the security_action_id field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
    state string
    Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
    ttl string
    Input only. The TTL for this SecurityAction.
    updateTime string
    The update time for this SecurityAction. This reflects when this SecurityAction changed states.
    allow GoogleCloudApigeeV1SecurityActionAllowResponse
    Allow a request through if it matches this SecurityAction.
    condition_config GoogleCloudApigeeV1SecurityActionConditionConfigResponse
    A valid SecurityAction must contain at least one condition.
    create_time str
    The create time for this SecurityAction.
    deny GoogleCloudApigeeV1SecurityActionDenyResponse
    Deny a request through if it matches this SecurityAction.
    description str
    Optional. An optional user provided description of the SecurityAction.
    expire_time str
    The expiration for this SecurityAction.
    flag GoogleCloudApigeeV1SecurityActionFlagResponse
    Flag a request through if it matches this SecurityAction.
    name str
    Immutable. This field is ignored during creation as per AIP-133. Please set the security_action_id field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
    state str
    Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
    ttl str
    Input only. The TTL for this SecurityAction.
    update_time str
    The update time for this SecurityAction. This reflects when this SecurityAction changed states.
    allow Property Map
    Allow a request through if it matches this SecurityAction.
    conditionConfig Property Map
    A valid SecurityAction must contain at least one condition.
    createTime String
    The create time for this SecurityAction.
    deny Property Map
    Deny a request through if it matches this SecurityAction.
    description String
    Optional. An optional user provided description of the SecurityAction.
    expireTime String
    The expiration for this SecurityAction.
    flag Property Map
    Flag a request through if it matches this SecurityAction.
    name String
    Immutable. This field is ignored during creation as per AIP-133. Please set the security_action_id field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
    state String
    Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
    ttl String
    Input only. The TTL for this SecurityAction.
    updateTime String
    The update time for this SecurityAction. This reflects when this SecurityAction changed states.

    Supporting Types

    GoogleCloudApigeeV1SecurityActionConditionConfigResponse

    BotReasons List<string>
    Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection and Advanced API Scraper.
    IpAddressRanges List<string>
    Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.
    BotReasons []string
    Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection and Advanced API Scraper.
    IpAddressRanges []string
    Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.
    botReasons List<String>
    Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection and Advanced API Scraper.
    ipAddressRanges List<String>
    Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.
    botReasons string[]
    Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection and Advanced API Scraper.
    ipAddressRanges string[]
    Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.
    bot_reasons Sequence[str]
    Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection and Advanced API Scraper.
    ip_address_ranges Sequence[str]
    Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.
    botReasons List<String>
    Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection and Advanced API Scraper.
    ipAddressRanges List<String>
    Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.

    GoogleCloudApigeeV1SecurityActionDenyResponse

    ResponseCode int
    Optional. The HTTP response code if the Action = DENY.
    ResponseCode int
    Optional. The HTTP response code if the Action = DENY.
    responseCode Integer
    Optional. The HTTP response code if the Action = DENY.
    responseCode number
    Optional. The HTTP response code if the Action = DENY.
    response_code int
    Optional. The HTTP response code if the Action = DENY.
    responseCode Number
    Optional. The HTTP response code if the Action = DENY.

    GoogleCloudApigeeV1SecurityActionFlagResponse

    Headers List<Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1SecurityActionHttpHeaderResponse>
    Optional. A list of HTTP headers to be sent to the target in case of a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least one is mandatory.
    Headers []GoogleCloudApigeeV1SecurityActionHttpHeaderResponse
    Optional. A list of HTTP headers to be sent to the target in case of a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least one is mandatory.
    headers List<GoogleCloudApigeeV1SecurityActionHttpHeaderResponse>
    Optional. A list of HTTP headers to be sent to the target in case of a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least one is mandatory.
    headers GoogleCloudApigeeV1SecurityActionHttpHeaderResponse[]
    Optional. A list of HTTP headers to be sent to the target in case of a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least one is mandatory.
    headers Sequence[GoogleCloudApigeeV1SecurityActionHttpHeaderResponse]
    Optional. A list of HTTP headers to be sent to the target in case of a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least one is mandatory.
    headers List<Property Map>
    Optional. A list of HTTP headers to be sent to the target in case of a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least one is mandatory.

    GoogleCloudApigeeV1SecurityActionHttpHeaderResponse

    Name string
    The header name to be sent to the target.
    Value string
    The header value to be sent to the target.
    Name string
    The header name to be sent to the target.
    Value string
    The header value to be sent to the target.
    name String
    The header name to be sent to the target.
    value String
    The header value to be sent to the target.
    name string
    The header name to be sent to the target.
    value string
    The header value to be sent to the target.
    name str
    The header name to be sent to the target.
    value str
    The header value to be sent to the target.
    name String
    The header name to be sent to the target.
    value String
    The header value to be sent to the target.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi