customresources

package
v1.166.1-devpreview Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 29, 2022 License: Apache-2.0 Imports: 11 Imported by: 0

README

AWS CDK Custom Resources

Provider Framework

AWS CloudFormation custom resources are extension points to the provisioning engine. When CloudFormation needs to create, update or delete a custom resource, it sends a lifecycle event notification to a custom resource provider. The provider handles the event (e.g. creates a resource) and sends back a response to CloudFormation.

The @aws-cdk/custom-resources.Provider construct is a "mini-framework" for implementing providers for AWS CloudFormation custom resources. The framework offers a high-level API which makes it easier to implement robust and powerful custom resources and includes the following capabilities:

  • Handles responses to AWS CloudFormation and protects against blocked deployments
  • Validates handler return values to help with correct handler implementation
  • Supports asynchronous handlers to enable operations that require a long waiting period for a resource, which can exceed the AWS Lambda timeout
  • Implements default behavior for physical resource IDs.

The following code shows how the Provider construct is used in conjunction with a CustomResource and a user-provided AWS Lambda function which implements the actual handler.

var onEvent function
var isComplete function
var myRole role


myProvider := cr.NewProvider(this, jsii.String("MyProvider"), &providerProps{
	onEventHandler: onEvent,
	isCompleteHandler: isComplete,
	 // optional async "waiter"
	logRetention: logs.retentionDays_ONE_DAY,
	 // default is INFINITE
	role: myRole,
})

awscdk.NewCustomResource(this, jsii.String("Resource1"), &customResourceProps{
	serviceToken: myProvider.serviceToken,
})
awscdk.NewCustomResource(this, jsii.String("Resource2"), &customResourceProps{
	serviceToken: myProvider.serviceToken,
})

Providers are implemented through AWS Lambda functions that are triggered by the provider framework in response to lifecycle events.

At the minimum, users must define the onEvent handler, which is invoked by the framework for all resource lifecycle events (Create, Update and Delete) and returns a result which is then submitted to CloudFormation.

The following example is a skeleton for a Python implementation of onEvent:

def on_event(event, context):
  print(event)
  request_type = event['RequestType']
  if request_type == 'Create': return on_create(event)
  if request_type == 'Update': return on_update(event)
  if request_type == 'Delete': return on_delete(event)
  raise Exception("Invalid request type: %s" % request_type)

def on_create(event):
  props = event["ResourceProperties"]
  print("create new resource with props %s" % props)

  # add your create code here...
  physical_id = ...

  return { 'PhysicalResourceId': physical_id }

def on_update(event):
  physical_id = event["PhysicalResourceId"]
  props = event["ResourceProperties"]
  print("update resource %s with props %s" % (physical_id, props))
  # ...

def on_delete(event):
  physical_id = event["PhysicalResourceId"]
  print("delete resource %s" % physical_id)
  # ...

Users may also provide an additional handler called isComplete, for cases where the lifecycle operation cannot be completed immediately. The isComplete handler will be retried asynchronously after onEvent until it returns IsComplete: true, or until the total provider timeout has expired.

The following example is a skeleton for a Python implementation of isComplete:

def is_complete(event, context):
  physical_id = event["PhysicalResourceId"]
  request_type = event["RequestType"]

  # check if resource is stable based on request_type
  is_ready = ...

  return { 'IsComplete': is_ready }

Security Note: the Custom Resource Provider Framework will write the value of ResponseURL, which is a pre-signed S3 URL used to report the success or failure of the Custom Resource execution back to CloudFormation, in a readable form to the AWS Step Functions execution history.

Anybody who can list and read AWS StepFunction executions in your account will be able to write a fake response to this URL and make your CloudFormation deployments fail.

Do not use this library if your threat model requires that you cannot trust actors who are able to list StepFunction executions in your account.

Handling Lifecycle Events: onEvent

The user-defined onEvent AWS Lambda function is invoked whenever a resource lifecycle event occurs. The function is expected to handle the event and return a response to the framework that, at least, includes the physical resource ID.

If onEvent returns successfully, the framework will submit a "SUCCESS" response to AWS CloudFormation for this resource operation. If the provider is asynchronous (isCompleteHandler is defined), the framework will only submit a response based on the result of isComplete.

If onEvent throws an error, the framework will submit a "FAILED" response to AWS CloudFormation.

The input event includes the following fields derived from the [Custom Resource Provider Request]:

Field Type Description
RequestType String The type of lifecycle event: Create, Update or Delete.
LogicalResourceId String The template developer-chosen name (logical ID) of the custom resource in the AWS CloudFormation template.
PhysicalResourceId String This field will only be present for Update and Delete events and includes the value returned in PhysicalResourceId of the previous operation.
ResourceProperties JSON This field contains the properties defined in the template for this custom resource.
OldResourceProperties JSON This field will only be present for Update events and contains the resource properties that were declared previous to the update request.
ResourceType String The resource type defined for this custom resource in the template. A provider may handle any number of custom resource types.
RequestId String A unique ID for the request.
StackId String The ARN that identifies the stack that contains the custom resource.

The return value from onEvent must be a JSON object with the following fields:

Field Type Required Description
PhysicalResourceId String No The allocated/assigned physical ID of the resource. If omitted for Create events, the event's RequestId will be used. For Update, the current physical ID will be used. If a different value is returned, CloudFormation will follow with a subsequent Delete for the previous ID (resource replacement). For Delete, it will always return the current physical resource ID, and if the user returns a different one, an error will occur.
Data JSON No Resource attributes, which can later be retrieved through Fn::GetAtt on the custom resource object.
NoEcho Boolean No Whether to mask the output of the custom resource when retrieved by using the Fn::GetAtt function.
any any No Any other field included in the response will be passed through to isComplete. This can sometimes be useful to pass state between the handlers.
Asynchronous Providers: isComplete

It is not uncommon for the provisioning of resources to be an asynchronous operation, which means that the operation does not immediately finish, and we need to "wait" until the resource stabilizes.

The provider framework makes it easy to implement "waiters" by allowing users to specify an additional AWS Lambda function in isCompleteHandler.

The framework will repeatedly invoke the handler every queryInterval. When isComplete returns with IsComplete: true, the framework will submit a "SUCCESS" response to AWS CloudFormation. If totalTimeout expires and the operation has not yet completed, the framework will submit a "FAILED" response with the message "Operation timed out".

If an error is thrown, the framework will submit a "FAILED" response to AWS CloudFormation.

The input event to isComplete includes all request fields, combined with all fields returned from onEvent. If PhysicalResourceId has not been explicitly returned from onEvent, it's value will be calculated based on the heuristics described above.

The return value must be a JSON object with the following fields:

Field Type Required Description
IsComplete Boolean Yes Indicates if the operation has finished or not.
Data JSON No May only be sent if IsComplete is true and includes additional resource attributes. These attributes will be merged with the ones returned from onEvent
Physical Resource IDs

Every resource in CloudFormation has a physical resource ID. When a resource is created, the PhysicalResourceId returned from the Create operation is stored by AWS CloudFormation and assigned to the logical ID defined for this resource in the template. If a Create operation returns without a PhysicalResourceId, the framework will use RequestId as the default. This is sufficient for various cases such as "pseudo-resources" which only query data.

For Update and Delete operations, the resource event will always include the current PhysicalResourceId of the resource.

When an Update operation occurs, the default behavior is to return the current physical resource ID. if the onEvent returns a PhysicalResourceId which is different from the current one, AWS CloudFormation will treat this as a resource replacement, and it will issue a subsequent Delete operation for the old resource.

As a rule of thumb, if your custom resource supports configuring a physical name (e.g. you can specify a BucketName when you define an AWS::S3::Bucket), you must return this name in PhysicalResourceId and make sure to handle replacement properly. The S3File example demonstrates this through the objectKey property.

When there are errors

As mentioned above, if any of the user handlers fail (i.e. throws an exception) or times out (due to their AWS Lambda timing out), the framework will trap these errors and submit a "FAILED" response to AWS CloudFormation, along with the error message.

Since errors can occur in multiple places in the provider (framework, onEvent, isComplete), it is important to know that there could situations where a resource operation fails even though the operation technically succeeded (i.e. isComplete throws an error).

When AWS CloudFormation receives a "FAILED" response, it will attempt to roll back the stack to it's last state. This has different meanings for different lifecycle events:

  • If a Create event fails, the resource provider framework will automatically ignore the subsequent Delete operation issued by AWS CloudFormation. The framework currently does not support customizing this behavior (see https://github.com/aws/aws-cdk/issues/5524).
  • If an Update event fails, CloudFormation will issue an additional Update with the previous properties.
  • If a Delete event fails, CloudFormation will abandon this resource.
Important cases to handle

You should keep the following list in mind when writing custom resources to make sure your custom resource behaves correctly in all cases:

  • During Create:

    • If the create fails, the provider framework will make sure you don't get a subsequent Delete event. If your create involves multiple distinct operations, it is your responsibility to catch and rethrow and clean up any partial updates that have already been performed. Make sure your API call timeouts and Lambda timeouts allow for this.

  • During Update:

    • If the update fails, you will get a subsequent Update event to roll back to the previous state (with ResourceProperties and OldResourceProperties reversed).
    • If you return a different PhysicalResourceId, you will subsequently receive a Delete event to clean up the previous state of the resource.

  • During Delete:

    • If the behavior of your custom resource is tied to another AWS resource (for example, it exists to clean the contents of a stateful resource), keep in mind that your custom resource may be deleted independently of the other resource and you must confirm that it is appropriate to perform the action.
    • (only if you are not using the provider framework) a Delete event may be caused by a failed Create. You must be able to handle the case where the resource you are trying to delete hasn't even been created yet.

  • If you update the code of your custom resource and change the format of the resource properties, be aware that there may still be already-deployed instances of your custom resource out there, and you may still receive the old property format in ResourceProperties (during Delete and rollback Updates) or in OldResourceProperties (during rollforward Update). You must continue to handle all possible sets of properties your custom resource could have ever been created with in the past.

Provider Framework Execution Policy

Similarly to any AWS Lambda function, if the user-defined handlers require access to AWS resources, you will have to define these permissions by calling "grant" methods such as myBucket.grantRead(myHandler)), using myHandler.addToRolePolicy or specifying an initialPolicy when defining the function.

Bear in mind that in most cases, a single provider will be used for multiple resource instances. This means that the execution policy of the provider must have the appropriate privileges.

The following example grants the onEvent handler s3:GetObject* permissions to all buckets:

lambda.NewFunction(this, jsii.String("OnEventHandler"), &functionProps{
	runtime: lambda.runtime_NODEJS_14_X(),
	handler: jsii.String("index.handler"),
	code: lambda.code.fromInline(jsii.String("my code")),
	initialPolicy: []policyStatement{
		iam.NewPolicyStatement(&policyStatementProps{
			actions: []*string{
				jsii.String("s3:GetObject*"),
			},
			resources: []*string{
				jsii.String("*"),
			},
		}),
	},
})
Timeouts

Users are responsible to define the timeouts for the AWS Lambda functions for user-defined handlers. It is recommended not to exceed a 14 minutes timeout, since all framework functions are configured to time out after 15 minutes, which is the maximal AWS Lambda timeout.

If your operation takes over 14 minutes, the recommended approach is to implement an asynchronous provider, and then configure the timeouts for the asynchronous retries through the queryInterval and the totalTimeout options.

Provider Framework Examples

This module includes a few examples for custom resource implementations:

S3File

Provisions an object in an S3 bucket with textual contents. See the source code for the construct and handler.

The following example will create the file folder/file1.txt inside myBucket with the contents hello!.

// This example exists only for TypeScript

declare const myBucket: s3.Bucket;
new cr.S3File(this, 'MyFile', {
  bucket: myBucket,
  objectKey: 'folder/file1.txt', // optional
  content: 'hello!',
  public: true, // optional
});

This sample demonstrates the following concepts:

  • Synchronous implementation (isComplete is not defined)
  • Automatically generates the physical name if objectKey is not defined
  • Handles physical name changes
  • Returns resource attributes
  • Handles deletions
  • Implemented in TypeScript
S3Assert

Checks that the textual contents of an S3 object matches a certain value. The check will be retried for 5 minutes as long as the object is not found or the value is different. See the source code for the construct and handler.

The following example defines an S3Assert resource which waits until myfile.txt in myBucket exists and includes the contents foo bar:

// This example exists only for TypeScript

declare const myBucket: s3.Bucket;
new cr.S3Assert(this, 'AssertMyFile', {
  bucket: myBucket,
  objectKey: 'myfile.txt',
  expectedContent: 'foo bar',
});

This sample demonstrates the following concepts:

  • Asynchronous implementation
  • Non-intrinsic physical IDs
  • Implemented in Python
Customizing Provider Function name

In multi-account environments or when the custom resource may be re-utilized across several stacks it may be useful to manually set a name for the Provider Function Lambda and therefore have a predefined service token ARN.

var onEvent function
var isComplete function
var myRole role

myProvider := cr.NewProvider(this, jsii.String("MyProvider"), &providerProps{
	onEventHandler: onEvent,
	isCompleteHandler: isComplete,
	logRetention: logs.retentionDays_ONE_DAY,
	role: myRole,
	providerFunctionName: jsii.String("the-lambda-name"),
})

Custom Resources for AWS APIs

Sometimes a single API call can fill the gap in the CloudFormation coverage. In this case you can use the AwsCustomResource construct. This construct creates a custom resource that can be customized to make specific API calls for the CREATE, UPDATE and DELETE events. Additionally, data returned by the API call can be extracted and used in other constructs/resources (creating a real CloudFormation dependency using Fn::GetAtt under the hood).

The physical id of the custom resource can be specified or derived from the data returned by the API call.

The AwsCustomResource uses the AWS SDK for JavaScript. Services, actions and parameters can be found in the API documentation.

Path to data must be specified using a dot notation, e.g. to get the string value of the Title attribute for the first item returned by dynamodb.query it should be Items.0.Title.S.

To make sure that the newest API calls are available the latest AWS SDK v2 is installed in the Lambda function implementing the custom resource. The installation takes around 60 seconds. If you prefer to optimize for speed, you can disable the installation by setting the installLatestAwsSdk prop to false.

Custom Resource Execution Policy

You must provide the policy property defining the IAM Policy that will be applied to the API calls. The library provides two factory methods to quickly configure this:

  • AwsCustomResourcePolicy.fromSdkCalls - Use this to auto-generate IAM Policy statements based on the configured SDK calls. Keep two things in mind when using this policy:

    • This policy variant assumes the IAM policy name has the same name as the API call. This is true in 99% of cases, but there are exceptions (for example, S3's PutBucketLifecycleConfiguration requires s3:PutLifecycleConfiguration permissions, Lambda's Invoke requires lambda:InvokeFunction permissions). Use fromStatements if you want to do a call that requires different IAM action names.
    • You will have to either provide specific ARNs, or explicitly use AwsCustomResourcePolicy.ANY_RESOURCE to allow access to any resource.

  • AwsCustomResourcePolicy.fromStatements - Use this to specify your own custom statements.

The custom resource also implements iam.IGrantable, making it possible to use the grantXxx() methods.

As this custom resource uses a singleton Lambda function, it's important to note that the function's role will eventually accumulate the permissions/grants from all resources.

Chained API calls can be achieved by creating dependencies:

awsCustom1 := cr.NewAwsCustomResource(this, jsii.String("API1"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		physicalResourceId: cr.physicalResourceId.of(jsii.String("...")),
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

awsCustom2 := cr.NewAwsCustomResource(this, jsii.String("API2"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]*string{
			"text": awsCustom1.getResponseField(jsii.String("Items.0.text")),
		},
		physicalResourceId: cr.*physicalResourceId.of(jsii.String("...")),
	},
	policy: cr.*awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})
Physical Resource Id Parameter

Some AWS APIs may require passing the physical resource id in as a parameter for doing updates and deletes. You can pass it by using PhysicalResourceIdReference.

awsCustom := cr.NewAwsCustomResource(this, jsii.String("aws-custom"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]*string{
			"text": jsii.String("..."),
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("...")),
	},
	onUpdate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]interface{}{
			"text": jsii.String("..."),
			"resourceId": cr.NewPhysicalResourceIdReference(),
		},
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})
Handling Custom Resource Errors

Every error produced by the API call is treated as is and will cause a "FAILED" response to be submitted to CloudFormation. You can ignore some errors by specifying the ignoreErrorCodesMatching property, which accepts a regular expression that is tested against the code property of the response. If matched, a "SUCCESS" response is submitted. Note that in such a case, the call response data and the Data key submitted to CloudFormation would both be an empty JSON object. Since a successful resource provisioning might or might not produce outputs, this presents us with some limitations:

  • PhysicalResourceId.fromResponse - Since the call response data might be empty, we cannot use it to extract the physical id.
  • getResponseField and getResponseFieldReference - Since the Data key is empty, the resource will not have any attributes, and therefore, invoking these functions will result in an error.

In both the cases, you will get a synth time error if you attempt to use it in conjunction with ignoreErrorCodesMatching.

Customizing the Lambda function implementing the custom resource

Use the role, timeout, logRetention and functionName properties to customize the Lambda function implementing the custom resource:

var myRole role

cr.NewAwsCustomResource(this, jsii.String("Customized"), &awsCustomResourceProps{
	role: myRole,
	 // must be assumable by the `lambda.amazonaws.com` service principal
	timeout: awscdk.Duration.minutes(jsii.Number(10)),
	 // defaults to 2 minutes
	logRetention: logs.retentionDays_ONE_WEEK,
	 // defaults to never delete logs
	functionName: jsii.String("my-custom-name"),
	 // defaults to a CloudFormation generated name
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})
Restricting the output of the Custom Resource

CloudFormation imposes a hard limit of 4096 bytes for custom resources response objects. If your API call returns an object that exceeds this limit, you can restrict the data returned by the custom resource to specific paths in the API response:

cr.NewAwsCustomResource(this, jsii.String("ListObjects"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("s3"),
		action: jsii.String("listObjectsV2"),
		parameters: map[string]*string{
			"Bucket": jsii.String("my-bucket"),
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("id")),
		outputPaths: []*string{
			jsii.String("Contents.0.Key"),
			jsii.String("Contents.1.Key"),
		},
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

Note that even if you restrict the output of your custom resource you can still use any path in PhysicalResourceId.fromResponse().

Custom Resource Examples
Verify a domain with SES
import route53 "github.com/aws/aws-cdk-go/awscdk"

var zone hostedZone


verifyDomainIdentity := cr.NewAwsCustomResource(this, jsii.String("VerifyDomainIdentity"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("SES"),
		action: jsii.String("verifyDomainIdentity"),
		parameters: map[string]*string{
			"Domain": jsii.String("example.com"),
		},
		physicalResourceId: cr.physicalResourceId.fromResponse(jsii.String("VerificationToken")),
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})
route53.NewTxtRecord(this, jsii.String("SESVerificationRecord"), &txtRecordProps{
	zone: zone,
	recordName: jsii.String("_amazonses.example.com"),
	values: []*string{
		verifyDomainIdentity.getResponseField(jsii.String("VerificationToken")),
	},
})
Get the latest version of a secure SSM parameter
getParameter := cr.NewAwsCustomResource(this, jsii.String("GetParameter"), &awsCustomResourceProps{
	onUpdate: &awsSdkCall{
		 // will also be called for a CREATE event
		service: jsii.String("SSM"),
		action: jsii.String("getParameter"),
		parameters: map[string]interface{}{
			"Name": jsii.String("my-parameter"),
			"WithDecryption": jsii.Boolean(true),
		},
		physicalResourceId: cr.physicalResourceId.of(date.now().toString()),
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

// Use the value in another construct with
getParameter.getResponseField(jsii.String("Parameter.Value"))
Associate a PrivateHostedZone with VPC shared from another account
getParameter := cr.NewAwsCustomResource(this, jsii.String("AssociateVPCWithHostedZone"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		assumedRoleArn: jsii.String("arn:aws:iam::OTHERACCOUNT:role/CrossAccount/ManageHostedZoneConnections"),
		service: jsii.String("Route53"),
		action: jsii.String("associateVPCWithHostedZone"),
		parameters: map[string]interface{}{
			"HostedZoneId": jsii.String("hz-123"),
			"VPC": map[string]*string{
				"VPCId": jsii.String("vpc-123"),
				"VPCRegion": jsii.String("region-for-vpc"),
			},
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("${vpcStack.SharedVpc.VpcId}-${vpcStack.Region}-${PrivateHostedZone.HostedZoneId}")),
	},
	//Will ignore any resource and use the assumedRoleArn as resource and 'sts:AssumeRole' for service:action
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

This module is part of the AWS Cloud Development Kit project.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func AwsCustomResourcePolicy_ANY_RESOURCE 

func AwsCustomResourcePolicy_ANY_RESOURCE() *[]*string

func AwsCustomResource_IsConstruct 

func AwsCustomResource_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

func NewAwsCustomResource_Override 

func NewAwsCustomResource_Override(a AwsCustomResource, scope constructs.Construct, id *string, props *AwsCustomResourceProps)

Experimental.

func NewPhysicalResourceIdReference_Override 

func NewPhysicalResourceIdReference_Override(p PhysicalResourceIdReference)

Experimental.

func NewProvider_Override 

func NewProvider_Override(p Provider, scope constructs.Construct, id *string, props *ProviderProps)

Experimental.

func Provider_IsConstruct 

func Provider_IsConstruct(x interface{}) *bool

Return whether the given object is a Construct. Experimental.

Types

type AwsCustomResource 

type AwsCustomResource interface {
	awscdk.Construct
	awsiam.IGrantable
	// The principal to grant permissions to.
	// Experimental.
	GrantPrincipal() awsiam.IPrincipal
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// Returns response data for the AWS SDK call as string.
	//
	// Example for S3 / listBucket : 'Buckets.0.Name'
	//
	// Note that you cannot use this method if `ignoreErrorCodesMatching`
	// is configured for any of the SDK calls. This is because in such a case,
	// the response data might not exist, and will cause a CloudFormation deploy time error.
	// Experimental.
	GetResponseField(dataPath *string) *string
	// Returns response data for the AWS SDK call.
	//
	// Example for S3 / listBucket : 'Buckets.0.Name'
	//
	// Use `Token.asXxx` to encode the returned `Reference` as a specific type or
	// use the convenience `getDataString` for string attributes.
	//
	// Note that you cannot use this method if `ignoreErrorCodesMatching`
	// is configured for any of the SDK calls. This is because in such a case,
	// the response data might not exist, and will cause a CloudFormation deploy time error.
	// Experimental.
	GetResponseFieldReference(dataPath *string) awscdk.Reference
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
}

Defines a custom resource that is materialized using specific AWS API calls.

These calls are created using a singleton Lambda function.

Use this to bridge any gap that might exist in the CloudFormation Coverage. You can specify exactly which calls are invoked for the 'CREATE', 'UPDATE' and 'DELETE' life cycle events.

Example: 

awsCustom := cr.NewAwsCustomResource(this, jsii.String("aws-custom"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]*string{
			"text": jsii.String("..."),
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("...")),
	},
	onUpdate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]interface{}{
			"text": jsii.String("..."),
			"resourceId": cr.NewPhysicalResourceIdReference(),
		},
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

Experimental.

func NewAwsCustomResource 

func NewAwsCustomResource(scope constructs.Construct, id *string, props *AwsCustomResourceProps) AwsCustomResource

Experimental.

type AwsCustomResourcePolicy 

type AwsCustomResourcePolicy interface {
	// resources for auto-generated from SDK calls.
	// Experimental.
	Resources() *[]*string
	// statements for explicit policy.
	// Experimental.
	Statements() *[]awsiam.PolicyStatement
}

The IAM Policy that will be applied to the different calls.

Example: 

awsCustom := cr.NewAwsCustomResource(this, jsii.String("aws-custom"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]*string{
			"text": jsii.String("..."),
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("...")),
	},
	onUpdate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]interface{}{
			"text": jsii.String("..."),
			"resourceId": cr.NewPhysicalResourceIdReference(),
		},
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

Experimental.

func AwsCustomResourcePolicy_FromSdkCalls 

func AwsCustomResourcePolicy_FromSdkCalls(options *SdkCallsPolicyOptions) AwsCustomResourcePolicy

Generate IAM Policy Statements from the configured SDK calls.

Each SDK call with be translated to an IAM Policy Statement in the form of: `call.service:call.action` (e.g `s3:PutObject`).

This policy generator assumes the IAM policy name has the same name as the API call. This is true in 99% of cases, but there are exceptions (for example, S3's `PutBucketLifecycleConfiguration` requires `s3:PutLifecycleConfiguration` permissions, Lambda's `Invoke` requires `lambda:InvokeFunction` permissions). Use `fromStatements` if you want to do a call that requires different IAM action names. Experimental.

func AwsCustomResourcePolicy_FromStatements 

func AwsCustomResourcePolicy_FromStatements(statements *[]awsiam.PolicyStatement) AwsCustomResourcePolicy

Explicit IAM Policy Statements. Experimental.

type AwsCustomResourceProps 

type AwsCustomResourceProps struct {
	// The policy that will be added to the execution role of the Lambda function implementing this custom resource provider.
	//
	// The custom resource also implements `iam.IGrantable`, making it possible
	// to use the `grantXxx()` methods.
	//
	// As this custom resource uses a singleton Lambda function, it's important
	// to note the that function's role will eventually accumulate the
	// permissions/grants from all resources.
	// See: Policy.fromSdkCalls
	//
	// Experimental.
	Policy AwsCustomResourcePolicy `field:"required" json:"policy" yaml:"policy"`
	// A name for the singleton Lambda function implementing this custom resource.
	//
	// The function name will remain the same after the first AwsCustomResource is created in a stack.
	// Experimental.
	FunctionName *string `field:"optional" json:"functionName" yaml:"functionName"`
	// Whether to install the latest AWS SDK v2. Allows to use the latest API calls documented at https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html.
	//
	// The installation takes around 60 seconds.
	// Experimental.
	InstallLatestAwsSdk *bool `field:"optional" json:"installLatestAwsSdk" yaml:"installLatestAwsSdk"`
	// The number of days log events of the singleton Lambda function implementing this custom resource are kept in CloudWatch Logs.
	// Experimental.
	LogRetention awslogs.RetentionDays `field:"optional" json:"logRetention" yaml:"logRetention"`
	// The AWS SDK call to make when the resource is created.
	// Experimental.
	OnCreate *AwsSdkCall `field:"optional" json:"onCreate" yaml:"onCreate"`
	// The AWS SDK call to make when the resource is deleted.
	// Experimental.
	OnDelete *AwsSdkCall `field:"optional" json:"onDelete" yaml:"onDelete"`
	// The AWS SDK call to make when the resource is updated.
	// Experimental.
	OnUpdate *AwsSdkCall `field:"optional" json:"onUpdate" yaml:"onUpdate"`
	// Cloudformation Resource type.
	// Experimental.
	ResourceType *string `field:"optional" json:"resourceType" yaml:"resourceType"`
	// The execution role for the singleton Lambda function implementing this custom resource provider.
	//
	// This role will apply to all `AwsCustomResource`
	// instances in the stack. The role must be assumable by the
	// `lambda.amazonaws.com` service principal.
	// Experimental.
	Role awsiam.IRole `field:"optional" json:"role" yaml:"role"`
	// The timeout for the singleton Lambda function implementing this custom resource.
	// Experimental.
	Timeout awscdk.Duration `field:"optional" json:"timeout" yaml:"timeout"`
}

Properties for AwsCustomResource.

Note that at least onCreate, onUpdate or onDelete must be specified.

Example: 

awsCustom := cr.NewAwsCustomResource(this, jsii.String("aws-custom"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]*string{
			"text": jsii.String("..."),
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("...")),
	},
	onUpdate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]interface{}{
			"text": jsii.String("..."),
			"resourceId": cr.NewPhysicalResourceIdReference(),
		},
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

Experimental.

type AwsSdkCall 

type AwsSdkCall struct {
	// The service action to call.
	// See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html
	//
	// Experimental.
	Action *string `field:"required" json:"action" yaml:"action"`
	// The service to call.
	// See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html
	//
	// Experimental.
	Service *string `field:"required" json:"service" yaml:"service"`
	// API version to use for the service.
	// See: https://docs.aws.amazon.com/sdk-for-javascript/v2/developer-guide/locking-api-versions.html
	//
	// Experimental.
	ApiVersion *string `field:"optional" json:"apiVersion" yaml:"apiVersion"`
	// Used for running the SDK calls in underlying lambda with a different role Can be used primarily for cross-account requests to for example connect hostedzone with a shared vpc.
	//
	// Example for Route53 / associateVPCWithHostedZone.
	// Experimental.
	AssumedRoleArn *string `field:"optional" json:"assumedRoleArn" yaml:"assumedRoleArn"`
	// The regex pattern to use to catch API errors.
	//
	// The `code` property of the
	// `Error` object will be tested against this pattern. If there is a match an
	// error will not be thrown.
	// Experimental.
	IgnoreErrorCodesMatching *string `field:"optional" json:"ignoreErrorCodesMatching" yaml:"ignoreErrorCodesMatching"`
	// Restrict the data returned by the custom resource to a specific path in the API response.
	//
	// Use this to limit the data returned by the custom
	// resource if working with API calls that could potentially result in custom
	// response objects exceeding the hard limit of 4096 bytes.
	//
	// Example for ECS / updateService: 'service.deploymentConfiguration.maximumPercent'
	// Deprecated: use outputPaths instead.
	OutputPath *string `field:"optional" json:"outputPath" yaml:"outputPath"`
	// Restrict the data returned by the custom resource to specific paths in the API response.
	//
	// Use this to limit the data returned by the custom
	// resource if working with API calls that could potentially result in custom
	// response objects exceeding the hard limit of 4096 bytes.
	//
	// Example for ECS / updateService: ['service.deploymentConfiguration.maximumPercent']
	// Experimental.
	OutputPaths *[]*string `field:"optional" json:"outputPaths" yaml:"outputPaths"`
	// The parameters for the service action.
	// See: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/index.html
	//
	// Experimental.
	Parameters interface{} `field:"optional" json:"parameters" yaml:"parameters"`
	// The physical resource id of the custom resource for this call.
	//
	// Mandatory for onCreate or onUpdate calls.
	// Experimental.
	PhysicalResourceId PhysicalResourceId `field:"optional" json:"physicalResourceId" yaml:"physicalResourceId"`
	// The region to send service requests to.
	//
	// **Note: Cross-region operations are generally considered an anti-pattern.**
	// **Consider first deploying a stack in that region.**
	// Experimental.
	Region *string `field:"optional" json:"region" yaml:"region"`
}

An AWS SDK call.

Example: 

awsCustom := cr.NewAwsCustomResource(this, jsii.String("aws-custom"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]*string{
			"text": jsii.String("..."),
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("...")),
	},
	onUpdate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]interface{}{
			"text": jsii.String("..."),
			"resourceId": cr.NewPhysicalResourceIdReference(),
		},
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

Experimental.

type PhysicalResourceId 

type PhysicalResourceId interface {
	// Literal string to be used as the physical id.
	// Experimental.
	Id() *string
	// Path to a response data element to be used as the physical id.
	// Experimental.
	ResponsePath() *string
}

Physical ID of the custom resource.

Example: 

awsCustom := cr.NewAwsCustomResource(this, jsii.String("aws-custom"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]*string{
			"text": jsii.String("..."),
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("...")),
	},
	onUpdate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]interface{}{
			"text": jsii.String("..."),
			"resourceId": cr.NewPhysicalResourceIdReference(),
		},
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

Experimental.

func PhysicalResourceId_FromResponse 

func PhysicalResourceId_FromResponse(responsePath *string) PhysicalResourceId

Extract the physical resource id from the path (dot notation) to the data in the API call response. Experimental.

func PhysicalResourceId_Of 

func PhysicalResourceId_Of(id *string) PhysicalResourceId

Explicit physical resource id. Experimental.

type PhysicalResourceIdReference 

type PhysicalResourceIdReference interface {
	awscdk.IResolvable
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// This may return an array with a single informational element indicating how
	// to get this property populated, if it was skipped for performance reasons.
	// Experimental.
	CreationStack() *[]*string
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_arg awscdk.IResolveContext) interface{}
	// toJSON serialization to replace `PhysicalResourceIdReference` with a magic string.
	// Experimental.
	ToJSON() *string
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

Reference to the physical resource id that can be passed to the AWS operation as a parameter.

Example: 

awsCustom := cr.NewAwsCustomResource(this, jsii.String("aws-custom"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]*string{
			"text": jsii.String("..."),
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("...")),
	},
	onUpdate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]interface{}{
			"text": jsii.String("..."),
			"resourceId": cr.NewPhysicalResourceIdReference(),
		},
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

Experimental.

func NewPhysicalResourceIdReference 

func NewPhysicalResourceIdReference() PhysicalResourceIdReference

Experimental.

type Provider 

type Provider interface {
	awscdk.Construct
	awscloudformation.ICustomResourceProvider
	// The user-defined AWS Lambda function which is invoked asynchronously in order to determine if the operation is complete.
	// Experimental.
	IsCompleteHandler() awslambda.IFunction
	// The construct tree node associated with this construct.
	// Experimental.
	Node() awscdk.ConstructNode
	// The user-defined AWS Lambda function which is invoked for all resource lifecycle operations (CREATE/UPDATE/DELETE).
	// Experimental.
	OnEventHandler() awslambda.IFunction
	// The service token to use in order to define custom resources that are backed by this provider.
	// Experimental.
	ServiceToken() *string
	// Called by `CustomResource` which uses this provider.
	// Deprecated: use `provider.serviceToken` instead
	Bind(_scope awscdk.Construct) *awscloudformation.CustomResourceProviderConfig
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	OnPrepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	OnSynthesize(session constructs.ISynthesisSession)
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	OnValidate() *[]*string
	// Perform final modifications before synthesis.
	//
	// This method can be implemented by derived constructs in order to perform
	// final changes before synthesis. prepare() will be called after child
	// constructs have been prepared.
	//
	// This is an advanced framework feature. Only use this if you
	// understand the implications.
	// Experimental.
	Prepare()
	// Allows this construct to emit artifacts into the cloud assembly during synthesis.
	//
	// This method is usually implemented by framework-level constructs such as `Stack` and `Asset`
	// as they participate in synthesizing the cloud assembly.
	// Experimental.
	Synthesize(session awscdk.ISynthesisSession)
	// Returns a string representation of this construct.
	// Experimental.
	ToString() *string
	// Validate the current construct.
	//
	// This method can be implemented by derived constructs in order to perform
	// validation logic. It is called on all constructs before synthesis.
	//
	// Returns: An array of validation error messages, or an empty array if the construct is valid.
	// Experimental.
	Validate() *[]*string
}

Defines an AWS CloudFormation custom resource provider.

Example: 

var onEvent function
var isComplete function
var myRole role

myProvider := cr.NewProvider(this, jsii.String("MyProvider"), &providerProps{
	onEventHandler: onEvent,
	isCompleteHandler: isComplete,
	logRetention: logs.retentionDays_ONE_DAY,
	role: myRole,
	providerFunctionName: jsii.String("the-lambda-name"),
})

Experimental.

func NewProvider 

func NewProvider(scope constructs.Construct, id *string, props *ProviderProps) Provider

Experimental.

type ProviderProps 

type ProviderProps struct {
	// The AWS Lambda function to invoke for all resource lifecycle operations (CREATE/UPDATE/DELETE).
	//
	// This function is responsible to begin the requested resource operation
	// (CREATE/UPDATE/DELETE) and return any additional properties to add to the
	// event, which will later be passed to `isComplete`. The `PhysicalResourceId`
	// property must be included in the response.
	// Experimental.
	OnEventHandler awslambda.IFunction `field:"required" json:"onEventHandler" yaml:"onEventHandler"`
	// The AWS Lambda function to invoke in order to determine if the operation is complete.
	//
	// This function will be called immediately after `onEvent` and then
	// periodically based on the configured query interval as long as it returns
	// `false`. If the function still returns `false` and the alloted timeout has
	// passed, the operation will fail.
	// Experimental.
	IsCompleteHandler awslambda.IFunction `field:"optional" json:"isCompleteHandler" yaml:"isCompleteHandler"`
	// The number of days framework log events are kept in CloudWatch Logs.
	//
	// When
	// updating this property, unsetting it doesn't remove the log retention policy.
	// To remove the retention policy, set the value to `INFINITE`.
	// Experimental.
	LogRetention awslogs.RetentionDays `field:"optional" json:"logRetention" yaml:"logRetention"`
	// Provider Lambda name.
	//
	// The provider lambda function name.
	// Experimental.
	ProviderFunctionName *string `field:"optional" json:"providerFunctionName" yaml:"providerFunctionName"`
	// Time between calls to the `isComplete` handler which determines if the resource has been stabilized.
	//
	// The first `isComplete` will be called immediately after `handler` and then
	// every `queryInterval` seconds, and until `timeout` has been reached or until
	// `isComplete` returns `true`.
	// Experimental.
	QueryInterval awscdk.Duration `field:"optional" json:"queryInterval" yaml:"queryInterval"`
	// AWS Lambda execution role.
	//
	// The role that will be assumed by the AWS Lambda.
	// Must be assumable by the 'lambda.amazonaws.com' service principal.
	// Experimental.
	Role awsiam.IRole `field:"optional" json:"role" yaml:"role"`
	// Security groups to attach to the provider functions.
	//
	// Only used if 'vpc' is supplied.
	// Experimental.
	SecurityGroups *[]awsec2.ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
	// Total timeout for the entire operation.
	//
	// The maximum timeout is 2 hours (yes, it can exceed the AWS Lambda 15 minutes).
	// Experimental.
	TotalTimeout awscdk.Duration `field:"optional" json:"totalTimeout" yaml:"totalTimeout"`
	// The vpc to provision the lambda functions in.
	// Experimental.
	Vpc awsec2.IVpc `field:"optional" json:"vpc" yaml:"vpc"`
	// Which subnets from the VPC to place the lambda functions in.
	//
	// Only used if 'vpc' is supplied. Note: internet access for Lambdas
	// requires a NAT gateway, so picking Public subnets is not allowed.
	// Experimental.
	VpcSubnets *awsec2.SubnetSelection `field:"optional" json:"vpcSubnets" yaml:"vpcSubnets"`
}

Initialization properties for the `Provider` construct.

Example: 

var onEvent function
var isComplete function
var myRole role

myProvider := cr.NewProvider(this, jsii.String("MyProvider"), &providerProps{
	onEventHandler: onEvent,
	isCompleteHandler: isComplete,
	logRetention: logs.retentionDays_ONE_DAY,
	role: myRole,
	providerFunctionName: jsii.String("the-lambda-name"),
})

Experimental.

type SdkCallsPolicyOptions 

type SdkCallsPolicyOptions struct {
	// The resources that the calls will have access to.
	//
	// It is best to use specific resource ARN's when possible. However, you can also use `AwsCustomResourcePolicy.ANY_RESOURCE`
	// to allow access to all resources. For example, when `onCreate` is used to create a resource which you don't
	// know the physical name of in advance.
	//
	// Note that will apply to ALL SDK calls.
	// Experimental.
	Resources *[]*string `field:"required" json:"resources" yaml:"resources"`
}

Options for the auto-generation of policies based on the configured SDK calls.

Example: 

awsCustom := cr.NewAwsCustomResource(this, jsii.String("aws-custom"), &awsCustomResourceProps{
	onCreate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]*string{
			"text": jsii.String("..."),
		},
		physicalResourceId: cr.physicalResourceId.of(jsii.String("...")),
	},
	onUpdate: &awsSdkCall{
		service: jsii.String("..."),
		action: jsii.String("..."),
		parameters: map[string]interface{}{
			"text": jsii.String("..."),
			"resourceId": cr.NewPhysicalResourceIdReference(),
		},
	},
	policy: cr.awsCustomResourcePolicy.fromSdkCalls(&sdkCallsPolicyOptions{
		resources: cr.*awsCustomResourcePolicy_ANY_RESOURCE(),
	}),
})

Experimental.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.