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

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.getSecurityProfile

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

    GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.

    Using getSecurityProfile

    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 getSecurityProfile(args: GetSecurityProfileArgs, opts?: InvokeOptions): Promise<GetSecurityProfileResult>
    function getSecurityProfileOutput(args: GetSecurityProfileOutputArgs, opts?: InvokeOptions): Output<GetSecurityProfileResult>
    def get_security_profile(organization_id: Optional[str] = None,
                             security_profile_id: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetSecurityProfileResult
    def get_security_profile_output(organization_id: Optional[pulumi.Input[str]] = None,
                             security_profile_id: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetSecurityProfileResult]
    func LookupSecurityProfile(ctx *Context, args *LookupSecurityProfileArgs, opts ...InvokeOption) (*LookupSecurityProfileResult, error)
    func LookupSecurityProfileOutput(ctx *Context, args *LookupSecurityProfileOutputArgs, opts ...InvokeOption) LookupSecurityProfileResultOutput

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

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

    The following arguments are supported:

    getSecurityProfile Result

    The following output properties are available:

    Description string
    Description of the security profile.
    DisplayName string
    Display name of the security profile.
    Environments List<Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityProfileEnvironmentResponse>
    List of environments attached to security profile.
    MaxScore int
    Maximum security score that can be generated by this profile.
    MinScore int
    Minimum security score that can be generated by this profile.
    Name string
    Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
    ProfileConfig Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1ProfileConfigResponse
    Customized profile configuration that computes the security score.
    RevisionCreateTime string
    The time when revision was created.
    RevisionId string
    Revision ID of the security profile.
    RevisionPublishTime string
    The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
    RevisionUpdateTime string
    The time when revision was updated.
    ScoringConfigs List<Pulumi.GoogleNative.Apigee.V1.Outputs.GoogleCloudApigeeV1SecurityProfileScoringConfigResponse>
    List of profile scoring configs in this revision.
    Description string
    Description of the security profile.
    DisplayName string
    Display name of the security profile.
    Environments []GoogleCloudApigeeV1SecurityProfileEnvironmentResponse
    List of environments attached to security profile.
    MaxScore int
    Maximum security score that can be generated by this profile.
    MinScore int
    Minimum security score that can be generated by this profile.
    Name string
    Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
    ProfileConfig GoogleCloudApigeeV1ProfileConfigResponse
    Customized profile configuration that computes the security score.
    RevisionCreateTime string
    The time when revision was created.
    RevisionId string
    Revision ID of the security profile.
    RevisionPublishTime string
    The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
    RevisionUpdateTime string
    The time when revision was updated.
    ScoringConfigs []GoogleCloudApigeeV1SecurityProfileScoringConfigResponse
    List of profile scoring configs in this revision.
    description String
    Description of the security profile.
    displayName String
    Display name of the security profile.
    environments List<GoogleCloudApigeeV1SecurityProfileEnvironmentResponse>
    List of environments attached to security profile.
    maxScore Integer
    Maximum security score that can be generated by this profile.
    minScore Integer
    Minimum security score that can be generated by this profile.
    name String
    Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
    profileConfig GoogleCloudApigeeV1ProfileConfigResponse
    Customized profile configuration that computes the security score.
    revisionCreateTime String
    The time when revision was created.
    revisionId String
    Revision ID of the security profile.
    revisionPublishTime String
    The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
    revisionUpdateTime String
    The time when revision was updated.
    scoringConfigs List<GoogleCloudApigeeV1SecurityProfileScoringConfigResponse>
    List of profile scoring configs in this revision.
    description string
    Description of the security profile.
    displayName string
    Display name of the security profile.
    environments GoogleCloudApigeeV1SecurityProfileEnvironmentResponse[]
    List of environments attached to security profile.
    maxScore number
    Maximum security score that can be generated by this profile.
    minScore number
    Minimum security score that can be generated by this profile.
    name string
    Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
    profileConfig GoogleCloudApigeeV1ProfileConfigResponse
    Customized profile configuration that computes the security score.
    revisionCreateTime string
    The time when revision was created.
    revisionId string
    Revision ID of the security profile.
    revisionPublishTime string
    The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
    revisionUpdateTime string
    The time when revision was updated.
    scoringConfigs GoogleCloudApigeeV1SecurityProfileScoringConfigResponse[]
    List of profile scoring configs in this revision.
    description str
    Description of the security profile.
    display_name str
    Display name of the security profile.
    environments Sequence[GoogleCloudApigeeV1SecurityProfileEnvironmentResponse]
    List of environments attached to security profile.
    max_score int
    Maximum security score that can be generated by this profile.
    min_score int
    Minimum security score that can be generated by this profile.
    name str
    Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
    profile_config GoogleCloudApigeeV1ProfileConfigResponse
    Customized profile configuration that computes the security score.
    revision_create_time str
    The time when revision was created.
    revision_id str
    Revision ID of the security profile.
    revision_publish_time str
    The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
    revision_update_time str
    The time when revision was updated.
    scoring_configs Sequence[GoogleCloudApigeeV1SecurityProfileScoringConfigResponse]
    List of profile scoring configs in this revision.
    description String
    Description of the security profile.
    displayName String
    Display name of the security profile.
    environments List<Property Map>
    List of environments attached to security profile.
    maxScore Number
    Maximum security score that can be generated by this profile.
    minScore Number
    Minimum security score that can be generated by this profile.
    name String
    Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
    profileConfig Property Map
    Customized profile configuration that computes the security score.
    revisionCreateTime String
    The time when revision was created.
    revisionId String
    Revision ID of the security profile.
    revisionPublishTime String
    The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
    revisionUpdateTime String
    The time when revision was updated.
    scoringConfigs List<Property Map>
    List of profile scoring configs in this revision.

    Supporting Types

    GoogleCloudApigeeV1ProfileConfigCategoryResponse

    Abuse Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1ProfileConfigAbuseResponse
    Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
    Authorization Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1ProfileConfigAuthorizationResponse
    Checks to see if you have an authorization policy in place.
    Cors Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1ProfileConfigCORSResponse
    Checks to see if you have CORS policy in place.
    Mediation Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1ProfileConfigMediationResponse
    Checks to see if you have a mediation policy in place.
    Mtls Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1ProfileConfigMTLSResponse
    Checks to see if you have configured mTLS for the target server.
    Threat Pulumi.GoogleNative.Apigee.V1.Inputs.GoogleCloudApigeeV1ProfileConfigThreatResponse
    Checks to see if you have a threat protection policy in place.
    Abuse GoogleCloudApigeeV1ProfileConfigAbuseResponse
    Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
    Authorization GoogleCloudApigeeV1ProfileConfigAuthorizationResponse
    Checks to see if you have an authorization policy in place.
    Cors GoogleCloudApigeeV1ProfileConfigCORSResponse
    Checks to see if you have CORS policy in place.
    Mediation GoogleCloudApigeeV1ProfileConfigMediationResponse
    Checks to see if you have a mediation policy in place.
    Mtls GoogleCloudApigeeV1ProfileConfigMTLSResponse
    Checks to see if you have configured mTLS for the target server.
    Threat GoogleCloudApigeeV1ProfileConfigThreatResponse
    Checks to see if you have a threat protection policy in place.
    abuse GoogleCloudApigeeV1ProfileConfigAbuseResponse
    Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
    authorization GoogleCloudApigeeV1ProfileConfigAuthorizationResponse
    Checks to see if you have an authorization policy in place.
    cors GoogleCloudApigeeV1ProfileConfigCORSResponse
    Checks to see if you have CORS policy in place.
    mediation GoogleCloudApigeeV1ProfileConfigMediationResponse
    Checks to see if you have a mediation policy in place.
    mtls GoogleCloudApigeeV1ProfileConfigMTLSResponse
    Checks to see if you have configured mTLS for the target server.
    threat GoogleCloudApigeeV1ProfileConfigThreatResponse
    Checks to see if you have a threat protection policy in place.
    abuse GoogleCloudApigeeV1ProfileConfigAbuseResponse
    Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
    authorization GoogleCloudApigeeV1ProfileConfigAuthorizationResponse
    Checks to see if you have an authorization policy in place.
    cors GoogleCloudApigeeV1ProfileConfigCORSResponse
    Checks to see if you have CORS policy in place.
    mediation GoogleCloudApigeeV1ProfileConfigMediationResponse
    Checks to see if you have a mediation policy in place.
    mtls GoogleCloudApigeeV1ProfileConfigMTLSResponse
    Checks to see if you have configured mTLS for the target server.
    threat GoogleCloudApigeeV1ProfileConfigThreatResponse
    Checks to see if you have a threat protection policy in place.
    abuse GoogleCloudApigeeV1ProfileConfigAbuseResponse
    Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
    authorization GoogleCloudApigeeV1ProfileConfigAuthorizationResponse
    Checks to see if you have an authorization policy in place.
    cors GoogleCloudApigeeV1ProfileConfigCORSResponse
    Checks to see if you have CORS policy in place.
    mediation GoogleCloudApigeeV1ProfileConfigMediationResponse
    Checks to see if you have a mediation policy in place.
    mtls GoogleCloudApigeeV1ProfileConfigMTLSResponse
    Checks to see if you have configured mTLS for the target server.
    threat GoogleCloudApigeeV1ProfileConfigThreatResponse
    Checks to see if you have a threat protection policy in place.
    abuse Property Map
    Checks for abuse, which includes any requests sent to the API for purposes other than what it is intended for, such as high volumes of requests, data scraping, and abuse related to authorization.
    authorization Property Map
    Checks to see if you have an authorization policy in place.
    cors Property Map
    Checks to see if you have CORS policy in place.
    mediation Property Map
    Checks to see if you have a mediation policy in place.
    mtls Property Map
    Checks to see if you have configured mTLS for the target server.
    threat Property Map
    Checks to see if you have a threat protection policy in place.

    GoogleCloudApigeeV1ProfileConfigResponse

    categories List<Property Map>
    List of categories of profile config.

    GoogleCloudApigeeV1SecurityProfileEnvironmentResponse

    AttachTime string
    Time at which environment was attached to the security profile.
    Environment string
    Name of the environment.
    AttachTime string
    Time at which environment was attached to the security profile.
    Environment string
    Name of the environment.
    attachTime String
    Time at which environment was attached to the security profile.
    environment String
    Name of the environment.
    attachTime string
    Time at which environment was attached to the security profile.
    environment string
    Name of the environment.
    attach_time str
    Time at which environment was attached to the security profile.
    environment str
    Name of the environment.
    attachTime String
    Time at which environment was attached to the security profile.
    environment String
    Name of the environment.

    GoogleCloudApigeeV1SecurityProfileScoringConfigResponse

    Description string
    Description of the config.
    ScorePath string
    Path of the component config used for scoring.
    Title string
    Title of the config.
    Description string
    Description of the config.
    ScorePath string
    Path of the component config used for scoring.
    Title string
    Title of the config.
    description String
    Description of the config.
    scorePath String
    Path of the component config used for scoring.
    title String
    Title of the config.
    description string
    Description of the config.
    scorePath string
    Path of the component config used for scoring.
    title string
    Title of the config.
    description str
    Description of the config.
    score_path str
    Path of the component config used for scoring.
    title str
    Title of the config.
    description String
    Description of the config.
    scorePath String
    Path of the component config used for scoring.
    title String
    Title of the config.

    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