AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
aws-native.synthetics.getCanary
Explore with Pulumi AI
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
Resource Type definition for AWS::Synthetics::Canary
Using getCanary
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 getCanary(args: GetCanaryArgs, opts?: InvokeOptions): Promise<GetCanaryResult>
function getCanaryOutput(args: GetCanaryOutputArgs, opts?: InvokeOptions): Output<GetCanaryResult>
def get_canary(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetCanaryResult
def get_canary_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetCanaryResult]
func LookupCanary(ctx *Context, args *LookupCanaryArgs, opts ...InvokeOption) (*LookupCanaryResult, error)
func LookupCanaryOutput(ctx *Context, args *LookupCanaryOutputArgs, opts ...InvokeOption) LookupCanaryResultOutput
> Note: This function is named LookupCanary
in the Go SDK.
public static class GetCanary
{
public static Task<GetCanaryResult> InvokeAsync(GetCanaryArgs args, InvokeOptions? opts = null)
public static Output<GetCanaryResult> Invoke(GetCanaryInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetCanaryResult> getCanary(GetCanaryArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:synthetics:getCanary
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- Name of the canary.
- Name string
- Name of the canary.
- name String
- Name of the canary.
- name string
- Name of the canary.
- name str
- Name of the canary.
- name String
- Name of the canary.
getCanary Result
The following output properties are available:
- Artifact
Config Pulumi.Aws Native. Synthetics. Outputs. Canary Artifact Config - Provide artifact configuration
- Artifact
S3Location string - Provide the s3 bucket output location for test results
- Code
Pulumi.
Aws Native. Synthetics. Outputs. Canary Code - Provide the canary script source
- Execution
Role stringArn - Lambda Execution role used to run your canaries
- Failure
Retention intPeriod - Retention period of failed canary runs represented in number of days
- Id string
- Id of the canary
- Run
Config Pulumi.Aws Native. Synthetics. Outputs. Canary Run Config - Provide canary run configuration
- Runtime
Version string - Runtime version of Synthetics Library
- Schedule
Pulumi.
Aws Native. Synthetics. Outputs. Canary Schedule - Frequency to run your canaries
- State string
- State of the canary
- Success
Retention intPeriod - Retention period of successful canary runs represented in number of days
- List<Pulumi.
Aws Native. Outputs. Tag> - Vpc
Config Pulumi.Aws Native. Synthetics. Outputs. Canary Vpc Config - Provide VPC Configuration if enabled.
- Artifact
Config CanaryArtifact Config - Provide artifact configuration
- Artifact
S3Location string - Provide the s3 bucket output location for test results
- Code
Canary
Code - Provide the canary script source
- Execution
Role stringArn - Lambda Execution role used to run your canaries
- Failure
Retention intPeriod - Retention period of failed canary runs represented in number of days
- Id string
- Id of the canary
- Run
Config CanaryRun Config - Provide canary run configuration
- Runtime
Version string - Runtime version of Synthetics Library
- Schedule
Canary
Schedule - Frequency to run your canaries
- State string
- State of the canary
- Success
Retention intPeriod - Retention period of successful canary runs represented in number of days
- Tag
- Vpc
Config CanaryVpc Config - Provide VPC Configuration if enabled.
- artifact
Config CanaryArtifact Config - Provide artifact configuration
- artifact
S3Location String - Provide the s3 bucket output location for test results
- code
Canary
Code - Provide the canary script source
- execution
Role StringArn - Lambda Execution role used to run your canaries
- failure
Retention IntegerPeriod - Retention period of failed canary runs represented in number of days
- id String
- Id of the canary
- run
Config CanaryRun Config - Provide canary run configuration
- runtime
Version String - Runtime version of Synthetics Library
- schedule
Canary
Schedule - Frequency to run your canaries
- state String
- State of the canary
- success
Retention IntegerPeriod - Retention period of successful canary runs represented in number of days
- List<Tag>
- vpc
Config CanaryVpc Config - Provide VPC Configuration if enabled.
- artifact
Config CanaryArtifact Config - Provide artifact configuration
- artifact
S3Location string - Provide the s3 bucket output location for test results
- code
Canary
Code - Provide the canary script source
- execution
Role stringArn - Lambda Execution role used to run your canaries
- failure
Retention numberPeriod - Retention period of failed canary runs represented in number of days
- id string
- Id of the canary
- run
Config CanaryRun Config - Provide canary run configuration
- runtime
Version string - Runtime version of Synthetics Library
- schedule
Canary
Schedule - Frequency to run your canaries
- state string
- State of the canary
- success
Retention numberPeriod - Retention period of successful canary runs represented in number of days
- Tag[]
- vpc
Config CanaryVpc Config - Provide VPC Configuration if enabled.
- artifact_
config CanaryArtifact Config - Provide artifact configuration
- artifact_
s3_ strlocation - Provide the s3 bucket output location for test results
- code
Canary
Code - Provide the canary script source
- execution_
role_ strarn - Lambda Execution role used to run your canaries
- failure_
retention_ intperiod - Retention period of failed canary runs represented in number of days
- id str
- Id of the canary
- run_
config CanaryRun Config - Provide canary run configuration
- runtime_
version str - Runtime version of Synthetics Library
- schedule
Canary
Schedule - Frequency to run your canaries
- state str
- State of the canary
- success_
retention_ intperiod - Retention period of successful canary runs represented in number of days
- Sequence[root_Tag]
- vpc_
config CanaryVpc Config - Provide VPC Configuration if enabled.
- artifact
Config Property Map - Provide artifact configuration
- artifact
S3Location String - Provide the s3 bucket output location for test results
- code Property Map
- Provide the canary script source
- execution
Role StringArn - Lambda Execution role used to run your canaries
- failure
Retention NumberPeriod - Retention period of failed canary runs represented in number of days
- id String
- Id of the canary
- run
Config Property Map - Provide canary run configuration
- runtime
Version String - Runtime version of Synthetics Library
- schedule Property Map
- Frequency to run your canaries
- state String
- State of the canary
- success
Retention NumberPeriod - Retention period of successful canary runs represented in number of days
- List<Property Map>
- vpc
Config Property Map - Provide VPC Configuration if enabled.
Supporting Types
CanaryArtifactConfig
- S3Encryption
Pulumi.
Aws Native. Synthetics. Inputs. Canary S3Encryption - Encryption configuration for uploading artifacts to S3
- S3Encryption
Canary
S3Encryption - Encryption configuration for uploading artifacts to S3
- s3Encryption
Canary
S3Encryption - Encryption configuration for uploading artifacts to S3
- s3Encryption
Canary
S3Encryption - Encryption configuration for uploading artifacts to S3
- s3_
encryption CanaryS3Encryption - Encryption configuration for uploading artifacts to S3
- s3Encryption Property Map
- Encryption configuration for uploading artifacts to S3
CanaryCode
- Handler string
- S3Bucket string
- S3Key string
- S3Object
Version string - Script string
- Source
Location stringArn
- Handler string
- S3Bucket string
- S3Key string
- S3Object
Version string - Script string
- Source
Location stringArn
- handler String
- s3Bucket String
- s3Key String
- s3Object
Version String - script String
- source
Location StringArn
- handler string
- s3Bucket string
- s3Key string
- s3Object
Version string - script string
- source
Location stringArn
- handler str
- s3_
bucket str - s3_
key str - s3_
object_ strversion - script str
- source_
location_ strarn
- handler String
- s3Bucket String
- s3Key String
- s3Object
Version String - script String
- source
Location StringArn
CanaryRunConfig
- Active
Tracing bool - Enable active tracing if set to true
- Environment
Variables Dictionary<string, string> - Environment variable key-value pairs.
- Memory
In intMb - Provide maximum memory available for canary in MB
- Timeout
In intSeconds - Provide maximum canary timeout per run in seconds
- Active
Tracing bool - Enable active tracing if set to true
- Environment
Variables map[string]string - Environment variable key-value pairs.
- Memory
In intMb - Provide maximum memory available for canary in MB
- Timeout
In intSeconds - Provide maximum canary timeout per run in seconds
- active
Tracing Boolean - Enable active tracing if set to true
- environment
Variables Map<String,String> - Environment variable key-value pairs.
- memory
In IntegerMb - Provide maximum memory available for canary in MB
- timeout
In IntegerSeconds - Provide maximum canary timeout per run in seconds
- active
Tracing boolean - Enable active tracing if set to true
- environment
Variables {[key: string]: string} - Environment variable key-value pairs.
- memory
In numberMb - Provide maximum memory available for canary in MB
- timeout
In numberSeconds - Provide maximum canary timeout per run in seconds
- active_
tracing bool - Enable active tracing if set to true
- environment_
variables Mapping[str, str] - Environment variable key-value pairs.
- memory_
in_ intmb - Provide maximum memory available for canary in MB
- timeout_
in_ intseconds - Provide maximum canary timeout per run in seconds
- active
Tracing Boolean - Enable active tracing if set to true
- environment
Variables Map<String> - Environment variable key-value pairs.
- memory
In NumberMb - Provide maximum memory available for canary in MB
- timeout
In NumberSeconds - Provide maximum canary timeout per run in seconds
CanaryS3Encryption
- Encryption
Mode string - Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- Kms
Key stringArn - KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- Encryption
Mode string - Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- Kms
Key stringArn - KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- encryption
Mode String - Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- kms
Key StringArn - KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- encryption
Mode string - Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- kms
Key stringArn - KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- encryption_
mode str - Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- kms_
key_ strarn - KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
- encryption
Mode String - Encryption mode for encrypting artifacts when uploading to S3. Valid values: SSE_S3 and SSE_KMS.
- kms
Key StringArn - KMS key Arn for encrypting artifacts when uploading to S3. You must specify KMS key Arn for SSE_KMS encryption mode only.
CanarySchedule
- Expression string
- Duration
In stringSeconds
- Expression string
- Duration
In stringSeconds
- expression String
- duration
In StringSeconds
- expression string
- duration
In stringSeconds
- expression str
- duration_
in_ strseconds
- expression String
- duration
In StringSeconds
CanaryVpcConfig
- Security
Group List<string>Ids - Subnet
Ids List<string> - Vpc
Id string
- Security
Group []stringIds - Subnet
Ids []string - Vpc
Id string
- security
Group List<String>Ids - subnet
Ids List<String> - vpc
Id String
- security
Group string[]Ids - subnet
Ids string[] - vpc
Id string
- security_
group_ Sequence[str]ids - subnet_
ids Sequence[str] - vpc_
id str
- security
Group List<String>Ids - subnet
Ids List<String> - vpc
Id String
Tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
AWS Native is in preview. AWS Classic is fully supported.
AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi